Полное руководство. С# 4.0

Шилдт Герберт

пояснение Документирует параметр типа, на который указывает имя_параметра. Текст, обозна чаемый как пояснение, описывает пара метр типа

Обозначает имя_параметра

как имя пара метра типа 1042 Часть II. Библиотека C# // Пример составления документирующих комментариев. using System; /* Это пример многострочного документирования в формате XML. В классе Test демонстрируется ряд дескрипторов. / class Test { /// /// Выполнение программы начинается с метода Main. /// static void Main { int sum; sum = Summation(5); Console.WriteLine("Сумма последовательных чисел " + 5 + " равна " + sum); } /// /// Метод Summation возвращает сумму его аргументов. /// /// Суммируемое значение передается в качестве параметра val. /// /// /// /// Сумма возвращается в виде значения типа int. /// /// static int Summation(int val) { int result = 0; for(int i=l; i <= val; i++) result += i; return result; } } Если

текст приведенной выше программы содержится в файле XmlTest.cs, то по следующей команде будет скомпилирована программа и получен файл XmlTest.xml, содержащий комментарии к ней. csc XmlTest.cs /doc:XmlTest.xml После компилирования получается XML-файл, содержимое которого приведено ниже. <?xml version="l.0"?>

DocTest

Это пример многострочного документирования в формате XML. В классе Test демонстрируется ряд дескрипторов.

Выполнение программы начинается с метода Main.

Метод Summation возвращает сумму его аргументов.

Суммируемое значение передается в качестве параметра val.

Сумма возвращается в виде значения типа int. Следует заметить, что каждому документируемому элементу присваивается уни кальный идентификатор. Такие идентификаторы применяются в других программах, которые документируются в формате XML.