PowerPoint-Präsentation

© 2004 Pohlig - Taulien
Dokumentation
mit JavaDoc
© 2004 Pohlig - Taulien
Kommentare in Java
// Dieser Kommentar gilt bis zum Zeilenende
/* Dieser Kommentar beginnt hier und endet
erst, wenn das kommende Zeichen auftritt.
Eignet sich auch, um Programmteile
auszukommentieren
*/
/** wie oben, nur mir dem Unterschied,
* dass javadoc.exe damit etwas anfangen kann
*/
GK Informatik mit Java
2
© 2004 Pohlig - Taulien
Dokumentations-Kommentare
• Mit Hilfe von Dokumentations-Kommentaren kann
javadoc.exe automatisch HTML-Seiten erzeugen.
• Sie stehen unmittelbar vor einer Klasse, einem
Konstruktor oder einer Methode.
• Innerhalb des Kommentars sind HTMLAnweisungen erlaubt.
• Mit Hilfe von speziellen „Schaltern“
–sie beginnen mit @ –
kann man die Gestaltung der Dokumentation
steuern.
GK Informatik mit Java
3
© 2004 Pohlig - Taulien
Beispiel
/**
* @version 2.0 Februar 2004
* @author Michael Pohlig.<br>
* Diese Klasse stellt eine Reihe <B>mathematischer
* Werkzeuge</B>
* zur Verfügung
*/
public class Mathematik {
/**
* @param a Koeffizient des quadratischen Glieds
* @param b Koeffizient des linearen Glieds
* @param c absolutes Glied
* @return Lösungen bzw. Lösungsmengen der
* quadratischen Gleichung ax^2 + bx +c =0
*/
public static String loeseQuadGl(double a, double b, double c){
if (a==0){
if (b==0){
GK Informatik mit Java
4
© 2004 Pohlig - Taulien
einige Schalter von JavaDoc
@author Text
fügt den Namen des Autors hinzu.
@version Text
fügt die Versions-Nummer hinzu.
@param Parameter Beschreibung fügt Informationen über die
Parameter eines Konstruktors oder
Methode hinzu.
@return Beschreibung
fügt Informationen über den
Rückgabewert einer Methode hinzu.
GK Informatik mit Java
5
© 2004 Pohlig - Taulien
Dokumentationen mit JavaEdit
Einige Schalter wie @author und
@version müssen besonders angegeben
werden.
GK Informatik mit Java
6
© 2004 Pohlig - Taulien
Dokumentationen mit JavaEdit
Sämtliche Dateien, die in
die Dokumentation mit
einbezogen werden
sollen, müssen in
JavaEdit geöffnet sein.
GK Informatik mit Java
7
© 2004 Pohlig - Taulien
Dokumentationen mit JavaEdit
Mit Start/JavaDoc wird
die Dokumentation
erstellt und automatisch
angezeigt.
GK Informatik mit Java
8
© 2004 Pohlig - Taulien
Dokumentationen mit JavaEdit
GK Informatik mit Java
9