Komentarze w Javie

Słownik kwalifikacji INF.04 - Projektowanie, programowanie i testowanie aplikacji

Komentarze w języku Java służą do opisywania kodu źródłowego. Są ignorowane przez kompilator, czyli nie wpływają na działanie programu. Ułatwiają zrozumienie kodu innym programistom oraz samemu autorowi po pewnym czasie.

Komentarz jednoliniowy

Komentarz jednoliniowy rozpoczyna się od znaków // i trwa do końca danej linii.

int wiek = 18; // deklaracja zmiennej przechowującej wiek

Stosuje się go zwykle do krótkich wyjaśnień.

Komentarz wieloliniowy

Komentarz wieloliniowy rozpoczyna się od /*, a kończy znakami */. Może obejmować jedną lub wiele linii.

/*
  To jest komentarz wieloliniowy.
  Może zajmować kilka linii kodu.
*/
int liczba = 10;

W pytaniach egzaminacyjnych poprawne oznaczenie komentarza wieloliniowego w Javie to:

/* ... */

Komentarz dokumentacyjny Javadoc

Java obsługuje także komentarze dokumentacyjne, rozpoczynane od /** i kończone */. Służą do generowania dokumentacji programu.

/**
 * Zwraca sumę dwóch liczb.
 * @param a pierwsza liczba
 * @param b druga liczba
 * @return suma liczb
 */
public int dodaj(int a, int b) {
    return a + b;
}

Najważniejsze do zapamiętania

  • // oznacza komentarz jednoliniowy.
  • /* ... */ oznacza komentarz wieloliniowy.
  • /** ... */ oznacza komentarz dokumentacyjny Javadoc.
  • Komentarze nie są wykonywane przez program.