Base di conoscenzaCentro esami
ITItaliano
Scegli la lingua13

CKTIS / Java

Commenti e documentazione in Java

Commenti e documentazione in Java: Java riconosce commenti di riga //, di blocco /* ... */ e di documentazione /** ... */; javadoc interpreta i tag e genera la documentazione API.

Versione: Java SE 21 (JLS and Java SE API); examples verified on the repository Java runtime

Sintassi

comments

Java riconosce commenti di riga //, di blocco /* ... / e di documentazione /* ... */; javadoc interpreta i tag e genera la documentazione API.

Usa Javadoc per il contratto di un’API pubblica con @param, @return e @throws, e {@code ...} per mostrare in sicurezza identificatori e frammenti di codice.

I commenti di blocco non si annidano: commentare codice che contiene */ chiude il commento in anticipo; un commento obsoleto è peggio di un nome preciso.

Gli escape Unicode sono elaborati prima della tokenizzazione: \u000a dentro // può diventare fine riga e far compilare il testo seguente come codice.

I commenti // e /* ... */ non cambiano l’esecuzione di int value = 7; l’unica riga di stdout 7 conferma che sono trattati come commenti.

Esempi

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);
    }
}

Risultato

7

I commenti // e /* ... */ non cambiano l’esecuzione di int value = 7; l’unica riga di stdout 7 conferma che sono trattati come commenti.

Fonti