Doxygen

Doxygen
Eine mit Doxygen erzeugte Dokumentation einer C++-Klasse
Basisdaten
Entwickler	Dimitri van Heesch
Erscheinungsjahr	26. Oktober 1997
Aktuelle Version	1.8.5 (23. August 2013)
Betriebssystem	Linux, Mac OS X, Solaris, Unix, Windows
Programmier­sprache	C++
Kategorie	Software-Dokumentationswerkzeug
Lizenz	GPL
deutschsprachig	ja
www.stack.nl/~dimitri/doxygen/

Doxygen ist ein von Dimitri van Heesch entwickeltes Software-Dokumentationswerkzeug, es steht als freie Software unter der GNU General Public License.

Durch spezielle Kommentare im Quelltext können Softwareentwickler Erläuterungen zu Programmelementen definieren, aus denen Doxygen eine übersichtliche Dokumentation erstellt. Außerdem ist es möglich, einen zusammenfassenden Überblick über den Aufbau und die Elemente eines bereits existierenden Programms (verwendete Dateien, Funktionen, Variablen sowie deren jew. Rolle im Programmablauf) zu erzeugen.

Das Ziel einer solchen Dokumentierungsmethode ist die Vermeidung von Redundanz. Da Programmstrukturen im Quelltext selbst beschrieben werden müssen, ist eine zusätzliche Dokumentierung der Strukturen (Funktionen, Klassen, Methoden usw.) in einer separaten Entwicklerdokumentierung fehleranfällig, da sich diese im Laufe einer Entwicklung häufig ändern. Zudem werden dem Entwickler der Aufwand einer separaten Dokumentenerstellung erspart und die Vollständigkeit der Dokumentierung gesichert und gesteigert.

Als grafische Benutzeroberfläche dient der sogenannte Doxywizard, mit dem die Einstellungen sehr einfach vorgenommen werden können.

Die meisten gängigen Entwicklungsumgebungen (IDE) unterstützen Doxygen durch Syntaxhervorhebung.

Unterstützte Programmiersprachen

Unterstützte Programmiersprachen sind C++, C, Objective-C, Java, Python, Fortran und IDL. Sie werden in ihrem vollen Sprachumfang unterstützt. Mit Einschränkungen ist auch die Kommentierung von PHP, C#, D und VHDL möglich. Seit Version 1.7.5 wird Tcl unterstützt. Durch zusätzliche Filter kann auch Quellcode in Perl oder Object Pascal bearbeitet werden.

Unterstützte Ausgabeformate

Als Ausgabeformat unterstützt Doxygen HTML, CHM, LaTeX, XML, RTF, PostScript, PDF, Manpages und Markdown. Auch lassen sich entsprechende Steuerdaten für die Erstellung von Hilfedateien für das Hilfesystem von Qt erstellen.

Beispiel

Die Dokumentierung einer Funktion kann wie folgt in den Quelltext eingebettet werden (hier in der Programmiersprache C):

 /**
  * \brief  Exemplarische Funktion
  *
  *         Diese Funktion gibt den übergebenen Parameter
  *         auf der Konsole aus.
  *
  * \param	parameter   Auszugebender Parameter
  * \return	            Status-Code
  *
  */
 int funktion(int parameter)
 {
     printf("Parameter: %d", parameter);

     return 0;
 }

Ähnliche Werkzeuge

• Javadoc, Natural Docs, phpDocumentor, ASDoc, ROBODoc, Sandcastle, AutoDuck, pydoc, HeaderDoc, Sphinx_(Software)

Weblinks

Commons: Doxygen – Sammlung von Bildern, Videos und Audiodateien

Wikibooks: C++-Programmierung: Dokumentation mit Doxygen – Lern- und Lehrmaterialien

• Offizielle Website (englisch)
• Tcl-Dox: Ein TCL-Filter für Doxygen (englisch)
• Pas2Dox: Ein Pascal-Filter für Doxygen (englisch)