|
Die Arten der Dokumentation lehnen sich in den entsprechenden Sprachen den z.T.
schon länger existierenden Werkzeugen an. Konkret bedeutet das, daß
folgende Dokumentationsmöglichkeiten von Doxygen unterstützt werden.
- JavaDoc für Java-Quelltexte
- KDoc bzw. Qt-Stil für QT bzw. KDE-Projekte
Zusätzlich existieren aber noch einige Erweiterungen, die weitergehende
Dokumentationsmöglichkeiten bieten.
Sehr positiv fällt z.B. auf, daß Informationen aus dem CVS über
die entsprechenden Schlüsselworte ebenfalls extrahiert werden können.
Ein Dokumentationsblock hat also eine der folgenden Formen:
- einzeilig:
//! Eine Zeile Dokumentationstext im Qt-Stil.
/// Eine Zeile Dokumentationstext im JavaDoc-Stil.
- mehrzeilig:
/*!
mehrzeiliger Dokumentationstext
im Qt-Stil
führende * in der Zeile werden entfernt;
werden sie dort benötigt, müssen sie zweimal eingegeben werden
*/
/**
* mehrzeiliger Dokumentationstext
* im JavaDoc-Stil
* führende * in der Zeile werden ebenfalls entfernt;
* werden sie dort benötigt, müssen sie zweimal eingegeben werden
*/
|
|