CKTIS / Java
Komentáre a dokumentácia v Jave
Komentáre a dokumentácia v Jave: Java rozpoznáva riadkové komentáre //, blokové /* ... */ a dokumentačné /** ... */; javadoc interpretuje značky a generuje z doc comments dokumentáciu API.
Verzia: Java SE 21 (JLS and Java SE API); examples verified on the repository Java runtime
Syntax
commentsJava rozpoznáva riadkové komentáre //, blokové /* ... / a dokumentačné /* ... */; javadoc interpretuje značky a generuje z doc comments dokumentáciu API.
Použi Javadoc pre kontrakt verejného API s @param, @return a @throws a {@code ...} na bezpečné zobrazenie identifikátorov a úryvkov kódu.
Blokové komentáre sa nevnárajú, takže zakomentovaný kód obsahujúci */ komentár predčasne ukončí; zastaraný komentár je horší než presný názov.
Unicode escapes sa spracujú pred tokenizáciou: \u000a vnútri // sa môže stať koncom riadka a nasledujúci text sa potom preloží ako kód.
Komentáre // a /* ... */ nemenia vykonanie int value = 7; jediný riadok stdout 7 potvrdzuje, že sa spracujú ako komentáre.
Prí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ýsledok
7
Komentáre // a /* ... */ nemenia vykonanie int value = 7; jediný riadok stdout 7 potvrdzuje, že sa spracujú ako komentáre.