Baza wiedzyCentrum egzaminacyjne
PLPolski
Wybierz język13

CKTIS / Java

Komentarze i dokumentacja w Javie

Komentarze i dokumentacja w Javie: Java rozpoznaje komentarze liniowe //, blokowe /* ... */ oraz dokumentacyjne /** ... */; javadoc interpretuje tagi i generuje dokumentację API z doc comments.

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

Składnia

comments

Java rozpoznaje komentarze liniowe //, blokowe /* ... / oraz dokumentacyjne /* ... */; javadoc interpretuje tagi i generuje dokumentację API z doc comments.

Stosuj Javadoc do kontraktu publicznego API z @param, @return i @throws, a {@code ...} do bezpiecznego pokazania identyfikatorów i fragmentów kodu.

Komentarze blokowe nie zagnieżdżają się, więc zakomentowanie kodu zawierającego */ kończy komentarz wcześniej; nieaktualny komentarz jest gorszy niż czytelna nazwa.

Unicode escapes są przetwarzane przed tokenizacją: zapis \u000a wewnątrz // może stać się końcem linii i sprawić, że dalszy tekst zostanie skompilowany jako kod.

Komentarze // i /* ... */ nie zmieniają wykonania przypisania int value = 7; jedyny wiersz stdout 7 potwierdza, że są pomijane jako komentarze.

Przykłady

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

Wynik

7

Komentarze // i /* ... */ nie zmieniają wykonania przypisania int value = 7; jedyny wiersz stdout 7 potwierdza, że są pomijane jako komentarze.

Źródła