doxygen
Software-Dokumentationswerkzeug
Basisdaten
Entwickler:	Dimitri van Heesch
Aktuelle Version:	1.5.6 (18. Mai 2008)
Betriebssystem:	Linux, Mac OS X, Solaris, Unix, Windows
Kategorie:	Software-Dokumentationswerkzeug
Lizenz:	GPL
Deutschsprachig:	ja
Website:	doxygen.org

Doxygen ist das bekannteste Open-Source-Software-Dokumentationswerkzeug und wurde von Dimitri van Heesch entwickelt. Es steht als Freie Software unter der GPL zur Verfügung.

Durch spezielle Kommentare im Quelltext können Software-Entwickler 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 Rolle im Programmablauf) zu erzeugen.

Das Ziel einer solchen Dokumentierungsmethode ist es, Redundanzen zu vermeiden. Da Programmstrukturen im Quelltext selbst beschrieben werden müssen, ist eine zusätzliche Dokumentierung der Strukturen (Funktionen, Klassen, Methoden etc.) in einer separaten Entwicklerdokumentierung fehleranfällig, da sich diese im Laufe einer Entwicklung häufig ändern. Zudem wird dem Entwickler der Aufwand einer Dokumentenerstellung erspart und die Vollständigkeit der Dokumentierung hoch gehalten.

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 „Syntax Highlighting“.

[Bearbeiten] Unterstützte Programmiersprachen

Unterstützte Programmiersprachen sind C++, C, Objective-C, Java, Python 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. Durch zusätzliche Filter kann auch Quellcode in Tcl bearbeitet werden.

[Bearbeiten] Unterstützte Ausgabeformate

Als Ausgabeformat unterstützt Doxygen HTML, CHM, LaTeX, XML, RTF, PostScript, PDF und Man pages.

[Bearbeiten] 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;
 }

[Bearbeiten] Ähnliche Werkzeuge

• JavaDoc, Natural Docs, PhpDocumentor (PhpDocumentor-Eintrag in englischer Wikipedia), ASDoc, ROBODoc, Sandcastle, AutoDuck, pydoc

[Bearbeiten] Weblinks

• Doxygen Homepage
• Linkseite zu "other documentation tools" auf der Homepage von Doxygen
• Tcl-Dox: Ein TCL-Filter für Doxygen (engl.)