Dokumentationen erstellen (Windows 95 oder NT)

Genau wie der Compiler oder der Interpreter, muss auch javadoc von einer DOS-Box gestartet werden.

javadoc [ Optionen ] package | Dateiname.java ...
extrahiert Kommentare aus Java-Quelldateien und erzeugt HTML-Seiten.

-classpath *Pfad*	Verzeichnisse, die Klassen enthalten (ignoriert CLASSPATH)
-d *Verzeichnis*	Verzeichnis, wo HTML-Dateien hingeschrieben werden
-verbose	protokolliert den Vorgang ausführlich
-version	fügt Versioneninformation hinzu
-author	fügt Autorname(n) hinzu
-sourcepath Pfad	gleich wie `-classpath`
-doctype	Dokumenttyp (HTML falls nichts anderes angegeben)
-noindex	generiert keinen Index aller Methoden und Felder
-notree	generiert keine Klassenhierarchie

Der Java API Dokumentationsgenerator oder kurz javadoc, liest eine Java-Quelldatei und generiert HTML-Seiten, die die Klassenschnittstelle beschreiben. Dazu müssen in den Java-Quelldateien spezielle Kommentare verwendet werden. Sie beginnen mit /** und enden auf */. In diesen sogenannten Doc Comments können Sie Standard HTML Tags verwenden. Vermeiden Sie jedoch Heading-Tags wie z.B. <h1> oder <hr>. Sie könnten mit der Dokumentenstruktur die von javadoc generiert wird in Konflikt stehen.

Nebst den HTML-Tags erkennt javadoc noch spezielle Tags. Diese beginnen mit @ und müssen am Anfang einer Zeile stehen. Damit javadoc Auflistungen erkennen kann, sollten Tags mit den gleichen Namen zusammengehalten werden.

javadoc-Kommentare müssen unmittelbar vor Klassen, Feldern oder Methoden stehen.

@see Tags

Diese Tags können in allen javadoc-Kommentaren vorkommen

@see Klassenname: erzeugt einen Link-Eintrag zu Klassenname unter «See Also».
@see Pfad-und-Klassenname: erzeugt einen voll qualifizierten Link-Eintrag zu Klassenname unter «See Also».
@see Pfad-und-Klassenname#Methodenname: erzeugt einen voll qualifizierten Link-Eintrag zur Methode unter «See Also».

Tags zur Klassendokumentation

@version Versionstext: erzeugt einen Eintrag unter «Version».
@author Name: erzeugt einen Eintrag unter «Author». Es können mehrere @author Tags vorkommen.

Tags zur Felddokumentation

Hier können nur @see Tags verwendet werden.

Tags zur Methodendokumentation

@param Parametername Beschreibung...: fügt die Beschreibung unter dem angegebenen Paramternamen in den Abschnitt «Parameters» ein.
@return Beschreibung...: generiert einen Abschnitt «Returns» mit der angegebenen Beschreibung.

Optionen

Die Dokumentation zu javadoc ist ein gutes Beispiel für eine schlechte Dokumentation. Wenn Sie in der Originaldokumentation nachschauen, sind die oben schwarz geschriebenen Optionen angegeben. Tippen Sie jedoch javadoc ohne Optionen und Parameter in einer DOS-Box, so erscheinen die violett geschriebenen Optionen als Hilfetext. Unsere Beobachtungen:

-version und -author müssen angegeben werden, wenn diese Informationen in der Dokumentation erscheinen sollen.
die Option -sourcepath ist einleuchtender als -classpath, verarbeitet javadoc doch Quelldateien und nicht kompilierte Klassen. Der Effekt ist bei beiden Optionen gleich. Denken Sie daran, dass beide (-sourcepath und -classpath) die Einstellungen der CLASSPATH-Variable unterdrücken.
-doctype funkioniert nur für HTML-Typen und macht daher (noch?) keinen Sinn.

Java-Dokumentation - javadoc - Tips und Hinweise - Lösungsmöglichkeit
OOP - Werkzeuge - Referenzen - Fäden - Synchronisation - Applets - Dokumentation
Werkstatt - Bibliographie