Co to jest komentarz?

Komentarz jest to tekst napisany w dowolnym języku, który nie jest brany pod uwagę podczas kompilacji programu. Używa się ich zwykle, by udokumentować i wytłumaczyć trudniejsze fragmenty kodu źródłowego. Częstą praktyką jest też użycie komentarzy do generowania dokumentacji programu. Pomagają w tym programy takie jak Doxygen.

Rodzaje komentarzy

Komentarze dzieli się na dwie grupy.

Komentarze jednolinijkowe

Są to komentarze, które zajmują najwyżej jedną linijkę. Stosuje się je zazwyczaj do wytłumaczenia jakiegoś fragmentu kodu źródłowego. Rozpoczyna się je znakami // , a koniec linii jest jednoznaczny z końcem komentarza. Przykład (bezsensowny, ale ukazuje istotę komentarzy):

a = b + 15; // dodajemy 15 do b
c = a * 2; //mnożymy a i 2

Komentarze wielolinijkowe

Te komentarze mogą (ale nie muszą) zajmować więcej niż jedną linię. Zapisuje się w nich zazwyczaj notę o licencji kodu źródlowego, ogólną dokumentację pewnej funkcji czy klasy. Rozpoczyna się je znakami /* , a kończy znakami */ . Przykład (Gwiazdki na początku linii nie są konieczne - zwiększają tylko czytelność):

/*
 * Funkcja dodaje dwie liczby i zwraca wynik operacji.
 *
 * Parametry:
 *     l1 -- Pierwsza z liczb do dodania
 *     l2 -- Druga z liczb do dodania
 */
int dodaj(int l1, int l2)
{
    return l1 + l2;
}

Komentarzy tych nie można zagnieżdżać, czyli taka konstrukcja:

/* komentarz
 /* zagnieżdżony komentarz */
*/

jest niedozwolona.