Programme dokumentieren mit JavaDoc

Präsentation zum Thema: "Programme dokumentieren mit JavaDoc"—  Präsentation transkript:

1 Programme dokumentieren mit JavaDoc
Michael Weiss

2 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

3 Beispiel: JavaDoc-Kommentare beginnen immer mit /**
import java.util.*; /** * Speichere die Zeit in Stunden, Minuten und Sekunden und * berechne die Winkel der drei Uhrzeiger. * Michael Weiss */ 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 pStd Stunden pMin Minuten 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

4 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. Winkel in Grad public double winkelStundenzeiger() return zStd * 30 + zMin * zSek * 0.5 / 60.0; zu beachten: Umlaute und Sonderzeichen durch HTML-Äquivalente ersetzen; siehe z.B. Tabelle auf @param Name Erklärung Erklärung sind für Methoden quasi obligatorisch, Autor Version/Datum für Klassen Michael Weiss

5 Erzeugung in BlueJ: Michael Weiss