CKTIS / Java
Kommentare und Dokumentation in Java
Kommentare und Dokumentation in Java: Java kennt Zeilenkommentare //, Blockkommentare /* ... */ und Dokumentationskommentare /** ... */; javadoc wertet Tags aus und erzeugt daraus API-Dokumentation.
Version: Java SE 21 (JLS and Java SE API); examples verified on the repository Java runtime
Syntax
commentsJava kennt Zeilenkommentare //, Blockkommentare /* ... / und Dokumentationskommentare /* ... */; javadoc wertet Tags aus und erzeugt daraus API-Dokumentation.
Nutze Javadoc für den Vertrag einer öffentlichen API mit @param, @return und @throws sowie {@code ...} zur sicheren Darstellung von Bezeichnern und Code.
Blockkommentare sind nicht verschachtelbar; auskommentierter Code mit */ beendet sie vorzeitig. Ein veralteter Kommentar ist schlechter als ein präziser Name.
Unicode Escapes werden vor der Tokenisierung verarbeitet: \u000a innerhalb von // kann zum Zeilenende werden und nachfolgenden Text als Code kompilieren lassen.
Die Kommentare // und /* ... */ ändern die Ausführung von int value = 7 nicht; die einzige Ausgabezeile 7 bestätigt ihre Behandlung als Kommentare.
Beispiele
public class Main {
public static void main(String[] args) {
int value = 7; // this comment does not change the expression
/* A block comment can span lines. */
System.out.println(value);
}
}
Ergebnis
7
Die Kommentare // und /* ... */ ändern die Ausführung von int value = 7 nicht; die einzige Ausgabezeile 7 bestätigt ihre Behandlung als Kommentare.