WikiDer > Dokumentationsgenerator

EIN Dokumentationsgenerator ist ein Computer Programm mit welcher Automatik Dokumentation kann erzeugt werden aus Kommentar in dem Quellcode oder aus Binärdateien. Diese Dokumentation ist für andere Programmierer als Beschreibung der API. Die meisten Dokumentationsgeneratoren generieren die Dokumentation als (X)HTML aber auch andere Formate werden unterstützt, wie z CHM, RTF, PDF, Latex, PostScript oder XML.

Beispiele für Dokumentationsgeneratoren sind Javadoc (vor dem Java), Schellfisch (vor dem Haskell) und Sauerstoff (für alle Sprachen).

Einige Dokumentationsgeneratoren bieten umfangreiche Möglichkeiten, das Layout und das Format der generierten Dokumentation anzupassen. Beispiele hierfür für die Dokumentation in (X)HTML sind die Verwendung von C.S.S, XSLT oder Seitenlayout-Vorlagen.

Kommentare im Quellcode

Dokumentationsgeneratoren können die Dokumentation aus Kommentaren generieren, die im Quellcode mit dem Funktionen und Methoden Zustand. Im objektorientierten Programmiersprachen ist dieser Ansatz weit verbreitet, da für alle Klasse eine Seite mit der Dokumentation der Methoden und der Felder.

Dokumentationsgeneratoren unterstützen oft auch eine bestimmte Syntax in den Kommentaren, um die Formatierung der endgültigen Dokumentation anzupassen. In Dokumentationsgeneratoren, die HTML ausgeben, ist es beispielsweise möglich, Hyperlink oder andere Formatierungen, die in den endgültigen HTML-Code integriert werden.