Baza wiedzyCentrum egzaminacyjne
PLPolski
Wybierz język13

CKTIS / C++

Komentarze i dokumentacja

C++ udostępnia komentarze // do końca wiersza oraz komentarze blokowe /* ... */. Pozwalają objaśniać kod i zapisywać dokumentację bez wykonywania ich treści. Komentarze blokowe nie mogą być zagnieżdżane.

Wersja: C++23; repository compiler flag, production runtime not attested

Składnia

// comment
/* comment */

Komentarz // kończy się bezpośrednio przed następnym znakiem nowego wiersza. Komentarz /* ... */ może obejmować wiele wierszy i kończy się na pierwszym */. Komentarze blokowe nie zagnieżdżają się: dodatkowe /* nie rozpoczyna wewnętrznego komentarza.

Podczas translacji każdy komentarz jest zastępowany jedną spacją, a znaki nowego wiersza są zachowywane. Dlatego int/**/value rozdziela int i value, natomiast va/**/lue nie tworzy identyfikatora value. Przed rozpoznaniem komentarzy następuje łączenie wierszy: znak \ na końcu wiersza z komentarzem // może sprawić, że komentarz obejmie również następny fizyczny wiersz. Unikaj takiego zapisu.

Zapisy dokumentacyjne, takie jak /// i /** ... */, są dla języka zwykłymi komentarzami; ich interpretacja jako dokumentacji zależy od osobnych narzędzi. Opisuj przede wszystkim cel, założenia i ograniczenia, zamiast powtarzać instrukcje kodu. W przykładzie komentarz /// opisuje add, a komentarz blokowy rozdziela tokeny w wyrażeniu.

Zakres wpisu to C++23. Podane źródło jest aktualizowanym szkicem roboczym, a nie zamrożonym wydaniem C++23. Wskazanie trybu kompilacji w repozytorium nie potwierdza środowiska uruchomieniowego produkcji.

Przykłady

#include <iostream>

/// Return the sum of two integers.
/// Precondition: The mathematical sum of a and b is representable as int.
int add(int a, int b) {
    return a /* first operand */ + b;
}

int main() {
    // Print the result once.
    std::cout << add(2, 3) << '\n';
}

Wynik

5

Wyświetlony kod i zadeklarowany wynik zweryfikowano w odizolowanym środowisku metodą zapisaną w dowodzie weryfikacji tej dokładnej wersji.

Źródła