С# Комментарии

Комментарии C#

В этой статье мы узнаем о комментариях C#, различных стилях комментариев, а также о том, почему и как их использовать в программе.

Комментарии используются в программе, чтобы помочь нам понять фрагмент кода. Это удобочитаемые слова, предназначенные для того, чтобы сделать код удобочитаемым. Комментарии полностью игнорируются компилятором.

В C# есть 3 типа комментариев:

1. Однострочные комментарии ( 05 )
2. Многострочные комментарии (19 )
3. Комментарии XML ( 22 )

Однострочные комментарии

Однострочные комментарии начинаются с двойной косой черты 34. . Компилятор игнорирует все после 41 до конца строки. Например,

06

Здесь 54 это комментарий.

Пример 1. Использование однострочного комментария

15 
 Приведенная выше программа содержит 3 однострочных комментария:
 
23
 
 и
 
37
 
 Однострочные комментарии могут быть написаны в отдельной строке или вместе с кодами в той же строке. Однако рекомендуется использовать комментарии в отдельной строке.
 <час> 
Многострочные комментарии
 
 Многострочные комментарии начинаются с 62 и заканчивается на 72 . Многострочные комментарии могут занимать несколько строк.
 
Пример 2. Использование многострочного комментария
 
45
 
 Вышеприведенная программа содержит 2 многострочных комментария:
 
54
 
 и
 
66
 
 
 
 Здесь мы могли заметить, что многострочный комментарий не обязательно должен занимать несколько строк.87 можно использовать вместо однострочных комментариев.
 <час> 
Комментарии к XML-документации
 
 Комментарий XML-документации — это особая функция C#. Он начинается с тройной косой черты 95. и используется для категорического описания фрагмента кода. Это делается с помощью тегов XML в комментарии. Затем эти комментарии используются для создания отдельного файла документации XML.
 
 Если вы не знакомы с XML, см. раздел Что такое XML?
 
Пример 3:Использование комментария XML-документации
 
78
 
 XML-комментарий, используемый в приведенной выше программе:
 
85
 
 Сгенерированная XML-документация (файл .xml) будет содержать:
 
95
 
 Посетите раздел Комментарии XML-документации, если хотите узнать больше.
 <час> 
Используйте комментарии правильно
 
 Комментарии используются для объяснения частей кода, но ими не следует злоупотреблять .
 
 Например:
 
102
 
 Использование комментария в приведенном выше примере не обязательно. Очевидно, что строка напечатает Hello World. В таких случаях следует избегать комментариев.
 
 
Вместо этого в программе следует использовать комментарии для объяснения сложных алгоритмов и методов.
 
Комментарии должны быть короткими и содержательными, а не длинным описанием.
 
Как правило, лучше объяснить, почему вместо как , используя комментарии.
 
 

            


            

               Выражения, операторы и блоки C# (с примерами)         
                C# if, if...else, if...else if и вложенный оператор if