Die Präsentation wird geladen. Bitte warten

Die Präsentation wird geladen. Bitte warten

Programme dokumentieren mit JavaDoc 08.02.20111Michael Weiss.

Ähnliche Präsentationen


Präsentation zum Thema: "Programme dokumentieren mit JavaDoc 08.02.20111Michael Weiss."—  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 Weiss2

3 Beispiel: Michael Weiss3 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(); } 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.

4 Beispiel (Forts.): Michael Weiss4 /** * 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; } /** * 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 Name Erklärung Erklärung sind für Methoden quasi obligatorisch, Autor Version/Datum für Klassen

5 Erzeugung in BlueJ: Michael Weiss5


Herunterladen ppt "Programme dokumentieren mit JavaDoc 08.02.20111Michael Weiss."

Ähnliche Präsentationen


Google-Anzeigen