50 likes | 146 Views
Programme dokumentieren mit JavaDoc. 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.
E N D
Programme dokumentieren mit JavaDoc Michael Weiss
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
Beispiel: importjava.util.*; /** * Speichere die Zeit in Stunden, Minuten und Sekunden und * berechne die Winkel der drei Uhrzeiger. * * @author Michael Weiss * @version 27.1.2011 */ publicclassZeit { privateintzStd,zMin; privatedoublezSek; /** * Konstruktorfür Objekte der Klasse Zeit. Stellt die Uhr auf die in den Parametern * übergebene Zeit * @parampStd Stunden * @parampMin Minuten * @parampSek Sekunden */ public Zeit(intpStd,intpMin,doublepSek) { 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
Beispiel (Forts.): /** * Konstruktorfü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 */ publicdoublewinkelStundenzeiger() { returnzStd*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 • @paramNameErklärung sowie @returnErklärung sind für Methoden quasi obligatorisch, entsprechend @authorAutor und @versionVersion/Datum für Klassen Michael Weiss
Erzeugung in BlueJ: Michael Weiss