Base de connaissancesCentre d’examen
FRFrançais
Choisir la langue13

CKTIS / Java

Commentaires et documentation en Java

Commentaires et documentation en Java: Java reconnaît les commentaires de ligne //, de bloc /* ... */ et de documentation /** ... */ ; javadoc interprète les tags et produit la documentation de l’API.

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

Syntaxe

comments

Java reconnaît les commentaires de ligne //, de bloc /* ... / et de documentation /* ... */ ; javadoc interprète les tags et produit la documentation de l’API.

Utilise Javadoc pour le contrat d’une API publique avec @param, @return et @throws, et {@code ...} pour présenter sûrement identifiants et extraits de code.

Les commentaires de bloc ne s’imbriquent pas : commenter du code contenant */ ferme le commentaire trop tôt ; un commentaire périmé vaut moins qu’un nom précis.

Les échappements Unicode sont traités avant la tokenisation : \u000a dans // peut devenir une fin de ligne et faire compiler le texte suivant comme du code.

Les commentaires // et /* ... */ ne changent pas l’exécution de int value = 7 ; l’unique ligne de sortie 7 confirme qu’ils sont ignorés comme commentaires.

Exemples

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

Résultat

7

Les commentaires // et /* ... */ ne changent pas l’exécution de int value = 7 ; l’unique ligne de sortie 7 confirme qu’ils sont ignorés comme commentaires.

Sources