Это пример многострочного документирования в формате XML.
В классе Test демонстрируется ряд дескрипторов.
</remark>
*/
class Test {
III <summary>
III Выполнение программы начинается с метода Main().
Ill </summary> static void Main() { int sum;
sum = Summation(5) ;
Console.WriteLine("Сумма последовательных чисел " +
5 + " равна " + sum);
}
III <summary>
III Метод Summation() возвращает сумму его аргументов.
Ill <param name = "val">
III Суммируемое значение передается в качестве параметра val.
Ill </param>
III <see cref="int"> </see>
III <returns>
III Сумма возвращается в виде значения типа int.
Ill </returns>
III </summary>
static int Summation(int val) { int result = 0;
for(int i=l; i <= val; i++) result += i;
Return result;
}
}
Если текст приведенной выше программы содержится в файле Xml Test. cs, то по следующей команде будет скомпилирована программа и получен файл Xml Test. xml, содержащий комментарии к ней.
csc XmlTest.cs /doc:XmlTest.xml
После компилирования получается XML-файл, содержимое которого приведено ниже.
<?xml version="l.0"?>
<doc>
<assembly>
<name>DocTest</name>
</assembly>
<members>
cmember name=ffT:Testff>
<remark>
Это пример многострочного документирования в формате XML. В классе Test демонстрируется ряд дескрипторов.
</remark>
</member>
<member name=lfM: Test .Main11 >
<summary>
Выполнение программы начинается с метода Main(). </summary>
</member>
<member name="M:Test.Summation(System.Int32)">
<summary>
Метод Summation() возвращает сумму его аргументов.
<param name="val">
Суммируемое значение передается в качестве параметра val. </param>
<see cref=”T:System.Int32"> </see>
<returns>
Сумма возвращается в виде значения типа int.
</returns>
</summary>
</member>
</members>
</doc>
Следует заметить, что каждому документируемому элементу присваивается уникальный идентификатор. Такие идентификаторы применяются в других программах, которые документируются в формате XML.
Предметный указатель
А
Аксессоры вызов 304
модификаторы доступа ограничения 323 применение 320 назначение 304 разновидности 304 событий 500 Анонимные функции назначение 483 преимущество 483 разновидности 483 Аргументы именованные назначение 252 применение 252 командной строки 255 метода 162 назначение 52 необязательные назначение 247 и неоднозначность 250 и перегрузка методов 249 порядок объявления 249 способы передачи методу 220 типа 579 Атрибуты AttributeUsage 570 Conditional 571
MethodlmplAttribute, применение 860
Obsolete 572
встроенные 570
Извлечение 564
Именованные параметры 566
назначение 562
Позиционные параметры 566
присоединение 564
Создание 563
указание 563
Б
Байт-код 34 Библиотека TPL возврат значения из задачи 899 задачи, создание и исполнение 887 идентификаторы задач, назначение и применение 890 классы
Parallel, назначение и применение 906 TaskFactory, назначение и применение 895 Task, назначение и применение 887 лямбда-выражения, в качестве задачи, применение 896 методы
Dispose(), назначение и применение 895 ForEach(), назначение и применение 915 ForQ, назначение и применение 909 Invoke(), назначение и применение 906 ожидания, назначение и применение 892 назначение 886 особенности 885 отмена задачи 901 признак отмены 901 продолжение задачи, создание 897 Библиотеки классов С#. 727
Для среды .NET Framework 66 организация 727 пространство имен System члены 729
структуры встроенных типов данных 727 Буферы фиксированного размера назначение 693 создание 694
В
Ввод-вывод в файл байтовый 441 символьный 449 последовательный 462 с произвольным доступом 462 данных в массив 463 двоичных данных 436,454 консольный 436 основанный на потоках 432 отдельными байтами 432 отдельными символами 432 переадресация 453 с запоминанием 465 Виртуальная машина Java 34 Возможность взаимодействия;
межъязыковая 35 Выводимость типов 609 Вызов