Wer sich mit Java Beschäftigt kommt meiner Meinung nach nicht an Kommentaren vorbei.
In Java gibt es drei Arten von Kommentaren:
- Der einzeilige Kommentar beginnt mit // und endet an Ende der aktuellen Zeile
- Der mehrzeilige Kommentar beginnt mit /* und wird mit */ beendet. Diese Art der Kommentare kann sich über mehrer Zeilen erstrecken.
- Das Dokumentationskommentare beginnt mit /** und endet mit */ und kann sich wie das mehrzeilige Kommentar über mehrer Zeilen erstrecken.
Im Gegensatz zu den anderen Kommentaren werden die Dokumentationskommentare mit Hilfe des Tools javadoc verwendet um aus der Quelle eine HTML-Dokumentation zu erstellen. Dokumentationskommentare stehen immer vor dem Element das sie beschreiben sollen.
Beispiel
[snippet id=“43″]
Javadoc-Parameter/Tags
| @param | Beschreibung der Parameter | @param a A Value. |
| @see | Verweis auf ein anderes Paket, Typ, Methode oder Eigenschaft | @see java.util.Date |
| @version | Version | @version 1.12 |
| @author | Autorenname /Ersteller | @author Max Mustermann |
| @return | Rückgabewert einer Methode | @return Number of elements |
| @exception/@throws | Ausnahmen, die von einer Methode ausgelöst werden können | @ception NumberFormatException |
| {@link} | Ein eingebauter Verweis im Text im Code-Font. Parameter wie bei @see | {@link java.io.File} |
| {@linkplain} | Wie {@link}, nur im normalen Font | {@linkplain java.io.File} |
| {@code} | Quellcode im Code-Zeichensatz – auch mit HTML-Sonderzeichen | {@code 1 ist < 2} |
| {@literal} | Maskiert HTML-Sonderzeichen. Kein Code-Zeichensatz | {@literal 1 < 2 && 2 > 1} |
Um das Symbol ‚@‘ zu verwenden, ohne ein Javadoc-Tag zu beginnen, kann der HTML-Zeichen-Code „@“ verwendet werden.