Doxygen
| Doxygen
| |
|---|---|
| [[Datei:Lua-Fehler in Modul:Wikidata, Zeile 1686: attempt to index field 'wikibase' (a nil value)|150px]] | |
| Screenshot Eine mit Doxygen erzeugte Dokumentation einer C++-Klasse | |
| Basisdaten
| |
| Maintainer | Lua-Fehler in Modul:Wikidata, Zeile 1686: attempt to index field 'wikibase' (a nil value) |
| Entwickler | Dimitri van Heesch |
| Erscheinungsjahr | Lua-Fehler in Modul:Wikidata, Zeile 1686: attempt to index field 'wikibase' (a nil value) |
| Aktuelle Version | Lua-Fehler in Modul:Wikidata, Zeile 1686: attempt to index field 'wikibase' (a nil value) (Lua-Fehler in Modul:Wikidata, Zeile 1686: attempt to index field 'wikibase' (a nil value)) |
| Aktuelle Vorabversion | Lua-Fehler in Modul:Wikidata, Zeile 1686: attempt to index field 'wikibase' (a nil value) (Lua-Fehler in Modul:Wikidata, Zeile 1686: attempt to index field 'wikibase' (a nil value)) |
| Betriebssystem | Linux, macOS, Solaris, Unix, Windows |
| Programmiersprache | Lua-Fehler in Modul:Wikidata, Zeile 1686: attempt to index field 'wikibase' (a nil value) |
| Kategorie | Software-Dokumentationswerkzeug |
| Lizenz | Lua-Fehler in Modul:Wikidata, Zeile 1686: attempt to index field 'wikibase' (a nil value) |
| deutschsprachig | ja |
| Lua-Fehler in Modul:Wikidata, Zeile 1686: attempt to index field 'wikibase' (a nil value) | |
Doxygen ist ein freies Software-Dokumentationswerkzeug unter der GNU General Public License.
Hintergrund und Motivation
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 jeweilige Rolle im Programmablauf) zu erzeugen.
Das Ziel einer solchen Dokumentationsmethode ist die Vermeidung von Redundanz und die Steigerung der Übersichtlichkeit des Codes. Die Dokumentation im Quelltext selbst kann dabei helfen, das Auseinanderdriften zwischen den Programmstrukturen (Funktionen, Klassen, Methoden usw.) und der Dokumentation zu verringern.
Als grafische Benutzeroberfläche dient der sogenannte Doxywizard, mit dem die Einstellungen, welche Art und Form der Dokumentationserzeugung steuern, einfach vorgenommen werden können.
Die meisten gängigen Entwicklungsumgebungen (IDE) unterstützen Doxygen durch Syntaxhervorhebung.
Die erste Doxygen-Version verwendete Quelltext von DOC++, das am Zuse-Institut Berlin von Roland Wunderling und Malte Zöckler entwickelt wurde.
Doxygen ist kompatibel zur Code-Versionierung mit Subversion, womit automatisch erzeugte Codes für Autoren, Bearbeiter, Datum und Zeitpunkt des Eincheckens in die Doxygen-Dokumentation übernommen werden können.
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. Ab 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.<ref>Doxygen Manual: Markdown support. Abgerufen am 20. August 2020.</ref> Auch lassen sich entsprechende Steuerdaten für die Erstellung von Hilfedateien für das Hilfesystem von Qt erstellen. Ab Version 1.8.8 wird auch PlantUML unterstützt, um UML-Diagramme zu erstellen.<ref>Doxygen Manual: Changelog. Abgerufen am 20. August 2020.</ref>
Beispiel
Die Dokumentierung einer Funktion kann wie folgt in den Quelltext eingebettet werden (hier in der Programmiersprache C): <syntaxhighlight lang="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; }
</syntaxhighlight>
Ähnliche Werkzeuge
- Javadoc, Natural Docs, phpDocumentor, ASDoc, ROBODoc, Sandcastle, AutoDuck, pydoc, HeaderDoc, Plain Old Documentation, Sphinx, CWEB.
Weblinks
- doxygen.nl (englisch)
- Pas2Dox: Ein Pascal-Filter für Doxygen (englisch)
Einzelnachweise
<references />