CKTIS / Java
Komentáře a dokumentace v Javě
Komentáře a dokumentace v Javě: Java rozpoznává řádkové komentáře //, blokové /* ... */ a dokumentační /** ... */; javadoc interpretuje značky a generuje z doc comments dokumentaci API.
Verze: Java SE 21 (JLS and Java SE API); examples verified on the repository Java runtime
Syntaxe
commentsJava rozpoznává řádkové komentáře //, blokové /* ... / a dokumentační /* ... */; javadoc interpretuje značky a generuje z doc comments dokumentaci API.
Použij Javadoc pro kontrakt veřejného API s @param, @return a @throws a {@code ...} k bezpečnému zobrazení identifikátorů a úryvků kódu.
Blokové komentáře se nevnořují, takže zakomentovaný kód obsahující */ komentář předčasně ukončí; zastaralý komentář je horší než přesný název.
Unicode escapes se zpracují před tokenizací: \u000a uvnitř // se může stát koncem řádku a následující text se pak přeloží jako kód.
Komentáře // a /* ... */ nemění provedení int value = 7; jediný řádek stdout 7 potvrzuje, že se zpracují jako komentáře.
Příklady
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);
}
}
Výsledek
7
Komentáře // a /* ... */ nemění provedení int value = 7; jediný řádek stdout 7 potvrzuje, že se zpracují jako komentáře.