WikiDer > Dsauerstoff

Sauerstoff
Entwickler	Dimitri van Heesch
Letzte Version	1.9.1 (8. Januar 2021)[1]
Status	Aktiv
Betriebssystem	Multiplattform
Geschrieben in	C
Kategorie	Dokumentationsgenerator
Lizenz	GPL
Versionskontrolle	github.com
Webseite	(und) Projektseite
Portal    Informatik Gratis Software

Sauerstoff ist ein kostenlosDokumentationsgenerator vor dem C , C, Java, IDL (Corba- und Microsoft-Varianten) und in begrenztem Umfang Ziel c, PHP, C# und d. Das Programm ist stark plattformunabhängig und läuft daher auf den meisten UnixSysteme, sondern auch auf Fenster und Mac. Der größte Teil des Codes für Doxygen wurde von . geschrieben Dimitri van Heesch.

Diverse Projekte, wie z K THE, verwenden Sie Doxygen, um die Dokumentation für ihre API. Die Entwicklungsumgebung KDevelop hat integrierte Unterstützung für Doxygen.

Doxygen kann die Dokumentation in verschiedenen gewünschten Formaten erstellen, wie z HTML, RTF, Latex, PostScript, PDF, und wenn man-Seiten.

Beispielcode

Der folgende Codeabschnitt veranschaulicht, wie eine Quelldatei dokumentiert wird.

/** * Die Zeitklasse repräsentiert eine Zeit. ** Autor John Doe */Klasse Time { /** * Konstruktor, der die Zeit mit einem angegebenen Wert übergibt. * Parametertimemillis ist die Anzahl der Millisekunden seit dem 1. Januar 1970 */ Time(int timemillis) { ... } /** * Gibt die aktuelle Uhrzeit zurück. * Rückkehr Ein Zeitobjekt, das die aktuelle Uhrzeit enthält. */ statisch Zeit jetzt() { ... }}

Die hiermit erstellte HTML-Version der Dokumentation kann wie in der folgenden Abbildung aussehen:

Ein Screenshot der HTML-Ausgabe von Doxygen.

Doxymagier

Doxygen funktioniert über die Befehlszeile oder über Konfigurationsdateien. Um dieses Programm benutzerfreundlicher zu machen, wurde Doxywizard entwickelt, das eine grafische Shell über Doxygen bietet. Dieses Programm ist auch für verschiedene Systeme verfügbar.

Externer Link

• (und) Projektseite