Base de conhecimentoCentro de Exames
PT · PTPortuguês (Portugal)
Escolher idioma13

CKTIS / Java

Comentários e documentação em Java

Comentários e documentação em Java: Java reconhece comentários de linha //, de bloco /* ... */ e de documentação /** ... */; javadoc interpreta tags e gera documentação da API.

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

Sintaxe

comments

Java reconhece comentários de linha //, de bloco /* ... / e de documentação /* ... */; javadoc interpreta tags e gera documentação da API.

Usa Javadoc para o contrato de uma API pública com @param, @return e @throws, e {@code ...} para mostrar identificadores e fragmentos de código em segurança.

Comentários de bloco não se aninham: comentar código que contém */ fecha o comentário cedo; um comentário desatualizado é pior que um nome preciso.

Unicode escapes são processados antes da tokenização: \u000a dentro de // pode tornar-se fim de linha e fazer o texto seguinte compilar como código.

Os comentários // e /* ... */ não alteram a execução de int value = 7; a única linha de stdout 7 confirma que são tratados como comentários.

Exemplos

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

Resultado

7

Os comentários // e /* ... */ não alteram a execução de int value = 7; a única linha de stdout 7 confirma que são tratados como comentários.

Fontes