Java Einführungs-Seminar

Dokumentationen

Sun, als Entwickler von Java, hat seit der Zusammenarbeit mit Netscape eine Vielzahl von Dokumentationen bereitgestellt und laufend ergänzt.

Zu den Dokumentationen gehört die Spezifikation der Sprache, der API und aller zusätzlichen Pakete.

Auch die Erstellung der eigenen Programmdokumentation wird in Java durch ein spezielles Tool unterstützt: javadoc. Dazu werden in den Quellcode spezielle Dokumentations-Kommentare mit aufgenommen. Diese Kommentare beginnen mit "/**" und enden mit "*/".

Hinweis: Die Kommentare müssen direkt vor der jeweils kommentierten Klasse stehen .

In den Dokumentationskommentaren können weitere Angaben gemacht werden. Die Zusatzangaben begnnen mit "@" und umfassen "author", "version" und andere Informationen.

Zur Erstellung dient das Tool "javadoc". Soll "javadoc" die weiteren Angaben auswerten, müssen die gewünschten Angaben explizit als Option beim Aufruf von "javadoc" angegeben werden.

javadoc -author -version Datei

Das Seminar wurde entwickelt von Walter Herglotz, München, 1999.
© Copyright "Walter digital", München, Walter Herglotz, 1999.