|
Zusätzlich künnen nun, um aus diesen Kommentar auch ein geeigneten
Dokumentationseintrag zu machen, einige besondere Tags angegeben werden,
die die nachfolgende Klasse, Methode, Struktur oder auch gesamte Datei
näher spezifizieren. Ein Tag wird durch \Tagname bzw. @Tagname
im Kommentar gekennzeichnet.
Die am häfigsten verwendeten Tags sind:
- @param beschreibt Parameter einer Funktion
- @return beschreibt Rückgabewert einer Funktion
- @class gibt nachfolgender Klasse (aussagekräftigeren) Namen
- @file gibt einen Überblick über den Inhalt einer Datei
- @struct beschreibt Struktur näher
- @brief Kurzbeschreibung, des nachfolgenden Elements (Klasse, Funktion, usw.)
- @author Autor (Hier kann sinnvollerweise auch nur $Author$ bzw. $Author:hame$ stehen)
- @version Versionsnummer
- @date Datum
- @bug Bekannte Fehler
- @warning Warnungen und Hinweise
- @see Referenzen auf andere Dokumente und Quelltexte
- @todo Was ist noch zu machen
Dies ist nur eine eine Auswahl. Es werden auch eine Vielzahl von HTML-Befehlen
und auch Latex-Befehlen (für das Einbinden von Formeln) unterstützt.
Beispiel-Quelltexte:
|
|