Komentarze w C#

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

Komentarze w C# służą do opisywania kodu źródłowego. Są ignorowane przez kompilator, czyli nie wpływają na działanie programu. W pytaniach egzaminacyjnych często trzeba rozpoznać poprawną składnię komentarza.

Komentarz jednoliniowy

Komentarz jednoliniowy w C# rozpoczyna się od znaków // i trwa do końca bieżącej linii.

Console.WriteLine(i); // wyświetlenie elementu tablicy

Taki komentarz może znajdować się:
- w osobnej linii,
- po instrukcji kodu,
- przy deklaracji zmiennej.

Przykład:

int liczba = 10; // przypisanie wartości do zmiennej

Komentarz wieloliniowy

Komentarz wieloliniowy rozpoczyna się od /*, a kończy na */.

/*
  Ten komentarz
  zajmuje kilka linii.
*/

Komentarz dokumentacyjny

W C# istnieją też komentarze dokumentacyjne rozpoczynające się od ///. Stosuje się je najczęściej nad klasami, metodami i właściwościami.

/// <summary>
/// Wyświetla komunikat użytkownikowi.
/// </summary>
void PokazKomunikat() { }

Ważne na egzaminie

Znak # nie oznacza komentarza w C#. Jest używany do dyrektyw preprocesora, np. #region, #if, #endif. Dlatego poprawny komentarz jednoliniowy w C# zaczyna się od //.