Страница 501 из 502
<b> ///</summary></b>
<b> static void Main() {</b>
<b> int sum;</b>
<b> sum = Summation(5);</b>
<b> Console.WriteLine("Сумма последовательных чисел " +</b>
<b> 5 + " равна " + sum);</b>
<b> }</b>
<b> ///<summary></b>
<b> /// Метод Summation() возвращает сумму его аргументов.</b>
<b> ///<param name = "val" ></b>
<b> /// Суммируемое значение передается в качестве параметра val.</b>
<b> ///</param></b>
<b> ///<see cref = "int" > </ see ></b>
<b> /// < returns ></b>
<b> /// Сумма возвращается в виде значения типа int.</b>
<b> ///</returns></b>
<b> /// </summary></b>
<b> static int Summation(int val) {</b>
<b> int result = 0;</b>
<b> for (int i = 1; i <= val; i++)</b>
<b> result += i;</b>
<b> return result;</b>
<b> }</b>
<b>}</b>
Если текст приведенной выше программы содержится в файле XmlTest.cs, то по следующей команде будет скомпилирована программа и получен файл XmlTest.xml, содержащий комментарии к ней.
<b>csc XmlTest.cs /doc:XmlTest.xml</b>
После компилирования получается XML-файл, содержимое которого приведено ниже.
<b><?xml version="1.0"?></b>
<b><doc></b>
<b> <assembly></b>
<b> <name>Program</name></b>
<b> </assembly></b>
<b> <members></b>
<b> <member name="T:Test"></b>
<b> <remark></b>
<b> Это пример многострочного документирования в формате XML.</b>
<b> В классе Test демонстрируется ряд дескрипторов.</b>
<b> </remark></b>
<b> </member></b>
<b> <member name="M:Test.Main"></b>
<b> <summary></b>
<b> Выполнение программы начинается с метода Main().</b>
<b> </summary></b>
<b> </member></b>
<b> <member name="M:Test.Summation(System.Int32)"></b>
<b> <summary></b>
<b> Метод Summation() возвращает сумму его аргументов.</b>
<b> <param name="val"></b>
<b> Суммируемое значение передается в качестве параметра val.</b>
<b> </param></b>
<b> <see cref="T:System.Int32"> </see></b>
<b> <returns></b>
<b> Сумма возвращается в виде значения типа int.</b>
<b> </returns></b>
<b> </summary></b>
<b> </member></b>
<b> </members></b>
<b></doc></b>
Следует заметить, что каждому документируемому элементу присваивается уникальный идентификатор. Такие идентификаторы применяются в других программах, которые документируются в формате XML.
Предметный указатель
(Удален. Все-равно номеров страниц нет. См. Оригинал)
Спецификации
HERBERT SCHILDT ПОЛНОЕ РУКОВОДСТВО C# 4.0
Москва • Санкт-Петербург • Киев 2011
ББК 32.973.26-018.2.75 Ш 57 УДК 681.3.07
Издательский дом "Вильямс"
Зав. редакцией С.Н. Тригуб Перевод с английского и редакция И.В. Берштейна
По общим вопросам обращайтесь в Издательский дом "Вильямс" по адресу: [email protected]/* */, http://www.williamspublishing.com
Шилдт, Герберт.
Ш57 C# 4.0: полное руководство. : Пер. с англ. — М. : ООО "И.Д. Вильямс", 2011. — 1056 с.: ил. — Парал. тит. англ.
ISBN 978-5-8459-1684-6 (рус.)
ББК 32.973.26-018.2.75
Все названия программных продуктов являются зарегистрированными торговыми марками соответствующих фирм.
Никакая часть настоящего издания ни в каких целях не может быть воспроизведена в какой бы то ни было форме и какими бы то ни было средствами, будь то электронные или механические, включая фотокопирование и запись на магнитный носитель, если на это нет письменного разрешения издательства McGrow-Hill Higher Ed.