Lernpfad:Würfelspiel in Java/Klassendokumentation mit Javadoc
< Lernpfad:Würfelspiel in Java
Zur Navigation springen
Zur Suche springen
Version vom 9. Mai 2018, 12:27 Uhr von Jneug (Diskussion | Beiträge)
Klassendokumentation mit Javadoc
Javadoc ist ein Format, um die Dokumentation von Klassen, Attributen und Methoden direkt im Quelltext zu verfassen. Dadurch ist die Dokumentation einer Methode direkt mit ihrem Quelltext verknüpft. Hält sich ein Programmierer an die Vorgaben des Formats, ergeben sich viele Vorteile:
- Klasse-Dateien lassen sich einfacher weitergeben und verstehen, da sie ihre eigene Dokumentation enthalten.
- Der eigene Quelltext wird lesbarer und lässt sich auch nach längerer Zeit nachvollziehen.
- Gängige Programmierumgebungen (wie z.B. BlueJ, Eclipse,
NetBeans) erkennen die Dokumentation und zeigen sie direkt im Programm an. Zum Teil erlauben sie auch das Durchsuchen der Kommentare.
- Aus dem Quelltext lässt sich direkt eine HTML-Version der Dokumentation erstellen, die separat vom Quelltext angezeigt
werden kann. Prominentestes Beispiel ist die offizielle Java API-Dokumentation.
/**
* Eine Klasse, die einen Motorroller repräsentiert.
* @author J. Neugebauer
* @version 2018-05-05
*/
public class Motorroller {
private int tankfuellung = 0;
/**
* Tankt den Roller auf.
* @param pMenge Die zu tankende Menge in Litern.
*/
public void tanken( int pMenge ) {
tankfuellung = tankfuellung + pMenge;
}
/**
* Getter für den Tankinhalt.
* @return Der aktuelle Tankinhalt in Litern.
*/
public int getTankfuellung() {
return tankfuellung;
}
}