Программирование на языке C#

3.3.
Комментарии 
Комментарии – пояснения к исходному тексту программы, 
находящиеся непосредственно внутри комментируемого кода. 
Комментировать строки программы полезно, поскольку это облегчает 
понимание кода для себя и для других.
С точки зрения компилятора или интерпретатора, комментарии – 
часть текста программы, не влияющая на её семантику. Комментарии 
не оказывают никакого влияния на результат компиляции программы 
или её интерпретацию.
С точки зрения синтаксиса, существуют два вида комментариев. 
Многострочный комментарий может иметь любую длину, он 
отмечается специальными символами в начале и конце (например
, /* 
*/
).
Однострочный комментарий отмечается специальным символом в 
начале (например, 
//
) и продолжается до конца строки. Допускается 
вложение однострочных комментариев в другие, как однострочные, 
так и многострочные комментарии. Способы записи можно 
чередовать, с точки зрения семантики они одинаковы. 
static void Main() 
{ 
/* Это самая популярная первая программа в учебниках по 
программированию и языкам программирования */ 
//Вывод строки 
System.Console.WriteLine("Hello World!"); 
} 
Для комментирования удобно пользоваться системой 
Doxygen
. 
Doxygen
– 
это система документирования исходных текстов, которая 
поддерживает много языков программирования, в том числе и C#. 
19 

---

Doxygen
генерирует документацию на основе набора текстов и 
также может быть настроен для извлечения структуры программы из 
недокументированных исходных кодов. Возможно составление графов 
зависимостей программных объектов, диаграмм классов и исходных 
кодов с гиперссылками. 
В код вставляются комментарии специального формата. 
Используются многострочные комментарии 
/** комментарий */
или 
/*! комментарий */
и однострочные 
/// комментарий 
или
//! комментарий. 
Все, что написано внутри комментариев, оформленных таким 
образом, выносится в документ, формируемый автоматически. Для 
единообразия лучше использовать 
///
для коротких комментариев и 
/** */
для длинных комментариев. В 
Doxygen
используются 
служебные слова, которые начинаются с 
символа @: @main, @code
и 
др., которые задают правила построения документации (выделение в 
отдельный раздел, специальное форматирование и шрифт для 
выделения примера кода и т.д.)
static void Main() { 
/** 
 Это самая популярная первая программа в учебниках по 
программированию и языкам программирования
*/ 
/// Вывод строки 
System.Console.WriteLine("Hello World!"); 
}