KennisbankExamencentrum
NL · NLNederlands (Nederland)
Taal kiezen13

CKTIS / Java

Commentaar en documentatie in Java

Commentaar en documentatie in Java: Java herkent regelcommentaar //, blokcommentaar /* ... */ en documentatiecommentaar /** ... */; javadoc verwerkt tags en genereert er API-documentatie uit.

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

Syntax

comments

Java herkent regelcommentaar //, blokcommentaar /* ... / en documentatiecommentaar /* ... */; javadoc verwerkt tags en genereert er API-documentatie uit.

Gebruik Javadoc voor het contract van een openbare API met @param, @return en @throws, en {@code ...} om namen en codefragmenten veilig te tonen.

Blokcommentaren nesten niet: uitgecommentarieerde code met */ sluit het commentaar te vroeg; verouderd commentaar is slechter dan een nauwkeurige naam.

Unicode escapes worden vóór tokenisatie verwerkt: \u000a binnen // kan een regeleinde worden en de volgende tekst als code laten compileren.

De commentaren // en /* ... */ veranderen de uitvoering van int value = 7 niet; de enige uitvoerregel 7 bevestigt dat ze als commentaar gelden.

Voorbeelden

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

Resultaat

7

De commentaren // en /* ... */ veranderen de uitvoering van int value = 7 niet; de enige uitvoerregel 7 bevestigt dat ze als commentaar gelden.

Bronnen