|
javadoc
Beschreibungsblock:
- Der erste Satz soll eine Kurzbeschreibung enthalten, weil er automatisch im Methodenindex auftaucht
- Die folgenden Sätze tauchen in der dezidierten Beschreibung auf und werden durch das erste '@'-Zeichen beendet
- Verwendet werden kann hier das 'inline tag' z.B. '{@link Object}' um Verweise auf bestehende Klassen zu erstellen.
- Mehrere Absätze werden in diesem Teil durch ein '<p>' getrennt.
- Danach schließt sich eine Leerzeile an
- Es gibt nur einen Beschreibungsblock, dieser steht immer vor der Parameterliste
Parameterliste
- Jede Parameterbeschreibung wird durch '@param', gefolgt vom Namen eingeleitet
- '@return' beschreibt den Inhalt des Rückgabewertes
- '@see' verweist auf verbundene Methoden und Klassen
|