Комментирование кода в C#
Язык C#, как и любой другой язык программирования содержит конструкции для оформления комментариев к коду.
Комментировать код необходимо, так как, во-первых, если Вам вдруг придется возвращаться к своему коду через некоторое время Вам буде легче вспомнить, о чем шла речь в определенной части кода, во-вторых, людям, которым, возможно, придется работать с Вашим кодом, будет легче вникнуть в суть.
Итак, C# поддерживает несколько видов комментариев, которые мы далее и рассмотрим.
Однострочные комментарии
// Это однострочный комментарий
Console.WriteLine("Привет комментарии в C#"); // Это тоже однострочный комментарий, но на другой строке
Как видно из примера выше, все ,что начинается в листинге кода с двух прямых слешей будет рассматриваться компилятором как комментарий и будет игнорироваться.
Многострочные комментарии
Начинаются с символов /* и заканчиваются символами */. Могут распространяться на несколько строк.
/*
Это многострочный комментарий, который
может распространяться на несколько строк
*/
Console.WriteLine("Привет комментарии в C#");
Комментарии, использующие XML-теги
Данный вид комментариев в C# используется тогда, когда необходимо сформировать документацию на программу на основе данных из комментариев. Это способ документирования кода удобен тем, что при необходимости Вы сразу сможете сформировать документацию по использованию Ваше программного кода в виде например, набора HTML страниц.
/// <summary>
/// Это метод возвращает код состояния
/// </summary>
public StatusCode GetSensorStatus();
Таким образом, вот такие виды комментариев существуют в C#. Однако, имейте ввиду, что комментировать стоит только те участки кода, которые будут в дальнейшем трудны для понимания. Не стоит комментировать все подряд.
-
Создано 12.11.2020 13:31:49
-
Михаил Русаков
Комментарии (0):
Для добавления комментариев надо войти в систему.
Если Вы ещё не зарегистрированы на сайте, то сначала зарегистрируйтесь.