Przestrzenie nazw
Warianty
Działania

Komentarz

Z cppreference.com
< cpp

Komentarze służą jako dokumentacja zawarta wewnątrz kodu. Wstawone do programu, są ignorowane przez kompilator. Ich jedną funkcją jest przekazanie informacji innym programistom czytającym kod źródłowy. Konkretny styl lub format dokumentacji nie jest opisany w standardzie języka, ale istnieją narzędzia pozwalające automatycznie przetwarzać specyficznie sformatowane komentarze i tworzyć z nich dokumentację.

Spis treści

[edytuj]Składnia

/*komentarz*/ (1)
//komentarz\n (2)
1) Często nazywany "stylem C" lub komentarzem wieloliniowym.
2) Często nazywany "stylem C++" lub komentarzem jednoliniwoym

Wszystkie komentarze usuwane są z programu w 3 fazie translacji poprzez zastąpienie ich pojedynczym białym znakiem.

[edytuj]Styl C

Komentarze w stylu C są zazwyczaj używane do komentowania większych bloków tekstu, ale mogą być też użyte w komentarzu składającym się z jednej linii. Aby wstawić komentarz w stylu C, należy otoczyć tekst komentarza zaczynając znacznikiem /* oraz kończąc */. Tekst komentarza zostanie zignorowany przez kompilator. Często znaczniki /** oraz */ są używane do oznaczenia bloku dokumentacji. Nie jest to część standardu, ale stanowi legalne wyrażenie C++ gdyż drugi znak * jest traktowany jako część komentarza. Komentarze w stylu C nie mogę być zagnieżdzane.

[edytuj]Styl C++

Komentarze w stylu C++ są zazwyczaj używane do utworzenia komentarza jednoliniowego, ale wielokrotne użycie znaku komentarza jednoliniwego w kolejnych liniach efektywnie utworzy komentarz wieloliniowy. Znacznik komentarza // powoduje że kompilator traktuje jako komentarz tekst począwszy od tego znaku do znaku końca linii.

[edytuj]Notatki

Z uwagi na to, że komentarze są usuwane zanim zostanie uruchomiony preprocesor, makro nie może być użyte do utworzenia komentarza, a nie zamknięte komentarze w stylu C nie propagują się z plików dołączonych dyrektywą #include.

Poza komentowaniem kodu, inne często używane mechanizmy do wyłączenia kodu z kompilacji to

#if 0std::cout<<"ten kod nie zostanie wykonany ani skompilowany\n";#endif

and

if(false){std::cout<<"ten kod nie zostanie wykonany\n"}

[edytuj]Przykład

/* Komentarz w stylu C może zawierać wiele linii *//* lub tylko jedną */   // Komentarze w stylu C++ mogą być użyte w pojedycznej linii   // lub być kontynuowane// w kolejnych liniach   int main(){// Poniższy kod nie zostanie wykonany// return 1;   // Poniższy kod zostanie wykonanyreturn0;}
close