Programme dokumentieren mit JavaDoc Michael Weiss 08.02.2011
Grundidee Beim Programmieren werden die (öffentlichen) Klassen und Methoden im Programmcode als Kommentar dokumentiert. Ein spezielles Werkzeug namens JavaDoc erzeugt daraus eine Dokumentation in HTML. Vorteil: Alle Java-Dokumentationen sehen praktisch gleich aus und sind prinzipiell sehr übersichtlich. Michael Weiss 08.02.2011
Beispiel: JavaDoc-Kommentare beginnen immer mit /** import java.util.*; /** * Speichere die Zeit in Stunden, Minuten und Sekunden und * berechne die Winkel der drei Uhrzeiger. * * @author Michael Weiss * @version 27.1.2011 */ public class Zeit { private int zStd, zMin; private double zSek; * Konstruktor für Objekte der Klasse Zeit. Stellt die Uhr auf die in den Parametern * übergebene Zeit * @param pStd Stunden * @param pMin Minuten * @param pSek Sekunden public Zeit(int pStd, int pMin, double pSek) zStd = pStd; zMin = pMin; zSek = pSek; normalisieren(); } JavaDoc-Kommentare beginnen immer mit /** und enden mit */. Sie stehen unmittelbar über der dokumentierten Klasse, bzw. Methode. Michael Weiss 08.02.2011
Beispiel (Forts.): zu beachten: /** * Konstruktor für Objekte der Klasse Zeit. Stellt die Uhr auf die aktuelle Systemzeit ein. */ public Zeit() { stellen(); } * Liefert die Position des Stundenzeigers zur im Objekt gespeicherten Zeit als Winkel in Grad, wobei * 0° 12 h, 90° 3 Uhr usw. entspricht. * @return Winkel in Grad public double winkelStundenzeiger() return zStd * 30 + zMin * 0.5 + zSek * 0.5 / 60.0; zu beachten: Umlaute und Sonderzeichen durch HTML-Äquivalente ersetzen; siehe z.B. Tabelle auf http://de.selfhtml.org/html/referenz/zeichen.htm @param Name Erklärung sowie @return Erklärung sind für Methoden quasi obligatorisch, entsprechend @author Autor und @version Version/Datum für Klassen Michael Weiss 08.02.2011
Erzeugung in BlueJ: Michael Weiss 08.02.2011