imported>Ebukadneza: Mehr wikidata in Infobox

2024-02-14T15:21:28Z

Mehr wikidata in Infobox

Neue Seite

{{Infobox Software
|Screenshot = [[Datei:Doxygen-1.8.1.png|250px|Screenshot]]
|Beschreibung = Eine mit Doxygen erzeugte Dokumentation einer C++-Klasse
|Hersteller = Dimitri van Heesch
|AktuelleVersion = 
|AktuelleVersionFreigabeDatum = 
|Betriebssystem = [[Linux]], [[macOS]], [[Solaris (Betriebssystem)|Solaris]], [[Unix]], [[Microsoft Windows NT|Windows]]
|Programmiersprache = 
|Kategorie = [[Software-Dokumentationswerkzeug]]
|Lizenz = 
|Deutsch = ja
|Website = 
}}

'''Doxygen''' ist ein [[Freie Software|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 [[Softwaredokumentation#Programmiererdokumentation|Dokumentation]] erstellt. Außerdem ist es möglich, einen zusammenfassenden Überblick über den Aufbau und die Elemente eines bereits existierenden [[Computerprogramm|Programms]] (verwendete [[Datei]]en, [[Funktion (Programmierung)|Funktionen]], [[Variable (Programmierung)|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 [[Konfiguration (Computer)|Einstellungen]], welche Art und Form der Dokumentationserzeugung steuern, einfach vorgenommen werden können.

Die meisten gängigen Entwicklungsumgebungen ([[Integrierte Entwicklungsumgebung|IDE]]) unterstützen Doxygen durch [[Syntaxhervorhebung]].

Die erste Doxygen-Version verwendete Quelltext von DOC++, das am [[Konrad-Zuse-Zentrum für Informationstechnik Berlin|Zuse-Institut Berlin]] von Roland Wunderling und Malte Zöckler entwickelt wurde.

Doxygen ist kompatibel zur [[Versionierung|Code-Versionierung]] mit [[Subversion (Software)|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 (Programmiersprache)|C]], [[Objective-C]], [[Java (Programmiersprache)|Java]], [[Python (Programmiersprache)|Python]], [[Fortran]] und [[Interface Description Language|IDL]]. Sie werden in ihrem vollen Sprachumfang unterstützt. Mit Einschränkungen ist auch die Kommentierung von [[PHP]], [[C-Sharp|C#]], [[D (Programmiersprache)|D]] und [[Very High Speed Integrated Circuit Hardware Description Language|VHDL]] möglich. Ab Version 1.7.5 wird [[Tcl]] unterstützt. Durch zusätzliche Filter kann auch Quellcode in [[Perl (Programmiersprache)|Perl]] oder [[Object Pascal]] bearbeitet werden.

== Unterstützte Ausgabeformate ==
Als Ausgabeformat unterstützt Doxygen [[Hypertext Markup Language|HTML]], [[CHM (Dateiformat)|CHM]], [[LaTeX]], [[Extensible Markup Language|XML]], [[Rich Text Format|RTF]], [[PostScript]], [[PDF]], [[Manpage]]s und [[Markdown]].<ref>{{Internetquelle |url=https://www.doxygen.nl/manual/markdown.html |titel=Doxygen Manual: Markdown support |abruf=2020-08-20}}</ref> Auch lassen sich entsprechende Steuerdaten für die Erstellung von Hilfedateien für das Hilfesystem von [[Qt (Bibliothek)|Qt]] erstellen. Ab Version 1.8.8 wird auch [[PlantUML]] unterstützt, um [[Unified Modeling Language#Diagramme|UML-Diagramme]] zu erstellen.<ref>{{Internetquelle |url=https://www.doxygen.nl/manual/changelog.html |titel=Doxygen Manual: Changelog |abruf=2020-08-20}}</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 (Software)|Sphinx]], [[WEB (Programmiersprache)|CWEB]].

== Weblinks ==
{{Commonscat}}
{{Wikibooks|C++-Programmierung: Dokumentation mit Doxygen}}
* [https://www.doxygen.nl/ doxygen.nl] (englisch)
* [https://sourceforge.net/projects/pas2dox/ Pas2Dox: Ein Pascal-Filter für Doxygen] (englisch)

== Einzelnachweise ==
<references />

[[Kategorie:Freies Programmierwerkzeug]]
[[Kategorie:Qt-basierte Software]]
[[Kategorie:Linux-Software]]
[[Kategorie:MacOS-Software]]
[[Kategorie:Windows-Software]]

Doxygen - Versionsgeschichte

imported>Ebukadneza: Mehr wikidata in Infobox