Doxygen
| Doxygen
| |
|---|---|
| |
 Eine mit Doxygen erzeugte Dokumentation einer C++-Klasse | |
| Basisdaten
| |
| Entwickler | Dimitri van Heesch |
| Erscheinungsjahr | 26. Oktober 1997[1] |
| Aktuelle Version | 1.12.0[2] (7. August 2024) |
| Betriebssystem | Linux, macOS, Solaris, Unix, Windows |
| Programmiersprache | C++ |
| Kategorie | Software-Dokumentationswerkzeug |
| Lizenz | GNU General Public License, Version 2[3] |
| deutschsprachig | ja |
| www.doxygen.org | |
Doxygen ist ein freies Software-Dokumentationswerkzeug unter der GNU General Public License.
Hintergrund und Motivation
[Bearbeiten | Quelltext bearbeiten]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
[Bearbeiten | Quelltext bearbeiten]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
[Bearbeiten | Quelltext bearbeiten]Als Ausgabeformat unterstützt Doxygen HTML, CHM, LaTeX, XML, RTF, PostScript, PDF, Manpages und Markdown.[4] 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.[5]
Beispiel
[Bearbeiten | Quelltext bearbeiten]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
[Bearbeiten | Quelltext bearbeiten]- Javadoc, Natural Docs, phpDocumentor, ASDoc, ROBODoc, Sandcastle, AutoDuck, pydoc, HeaderDoc, Plain Old Documentation, Sphinx, CWEB.
Weblinks
[Bearbeiten | Quelltext bearbeiten]
- doxygen.nl (englisch)
- Pas2Dox: Ein Pascal-Filter für Doxygen (englisch)
Einzelnachweise
[Bearbeiten | Quelltext bearbeiten]- ↑ web.archive.org.
- ↑ Doxygen release 1.12.0. 7. August 2024 (abgerufen am 7. August 2024).
- ↑ sourceforge.net. In: SourceForge. (abgerufen am 29. September 2016).
- ↑ Doxygen Manual: Markdown support. Abgerufen am 20. August 2020.
- ↑ Doxygen Manual: Changelog. Abgerufen am 20. August 2020.