In einem Javadoc Kommentar werden verschiedene Eigenschaften einer Methode beschrieben. Man spezifiziert die Übergabeparameter, Rückgabewerte, und vieles mehr.
Solche Kommentare werden stets mit /** eingeleitet. Danach erfolgt eine Beschreibung, welche Funktion die beschriebene Methode erfüllt.
Anschliessend können noch diverse Eigenschaften deklariert werden. Dies geschieht mit dem @ Zeichen. Hiermit kann man sagen, welche Parameter übergeben werden müssen, und was für eine Rückgabe die Methode liefert.
Beispiel:
/** * Hier kommt eine kurze Beschreibung der Klasse. * * @author Beni Ackle * @version 1.0 */ public class Calc{ /** * Addiert die beiden Übergabeparameter. * * @param zahl1 Dies ist der erste Summand * @param zahl2 Dies ist der zweite Summand * @return Gibt die Summe als Integer zurück */ public int calculate(int zahl1, int zahl2) { return zahl1 + zahl2; } }
