JavaDoc

Kommentare

JavaDoc/Doc++/doxygen-Kommentare zeichnen sich dadurch aus, dass sie als reguläre Kommentare vom Compiler erkannt werden und somit den Kompiliervorgang nicht beeinflussen.
Lediglich eine leichte Varianz in der Art der Kommentierung ist hierbei notwendig, damit in den Quelltext eingebundene Dokumentation auch zu einem späteren Zeitpunkt als gesondertes Dokument erstellt werden kann. Typischerweise wird der folgende Block genau vor das zu beschreibende Detail eingefügt:

/**
 *
 ...
 */
Dabei wird dieser möglichst in die Header-Datei eingetragen.
Zeilenumbrüche in der Dokumentation werden durch eine leere Zeile in der Kommentierung erzeugt.

Besonderheiten

Bei diesem Dokumentationssystem werden eine Reihe von speziellen Befehlen unterstützt, welche nun einzeln aufgelistet werden. Dabei ist zu beachten, dass pro Zeile nur ein Befehl verwendet werden darf.
Befehl Zweck
@return <beschreibung> Beschreibt den Rückgabewert.
@param <parameter> <beschreibung> Beschreibt den angegebenen Parameter.
@preconditions <beschreibung> Beschreibt die Vorbedingungen, welche vor Aufruf der Methode herrschen müssen.
@postconditions <beschreibung> Beschreibt die Nachbedingungen, welche nach Abarbeitung der Methode herrschen.
@see <verweis> Stellt einen Verweis in der Dokumentation her.
@author <autor> Der Autor.
@throws <klasse> <beschreibung> Beschreibt, ob und welche Klassen bei einem Fehler in dieser Methode geworfen werden können.
@deprecated <beschreibung> Wenn eine Methode veraltet ist (zweiter Zyklus!), so kann selbige mit diesem Befehl entsprechend markiert werden.
Es existieren noch eine Reihe weiterer Befehle, die hier aber nicht aufgelistet werden.