Читать «C# 4.0: полное руководство» онлайн - страница 672

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

  ///</param>

  ///<see cref = "int" > </ see >

  /// < returns >

  /// Сумма возвращается в виде значения типа int.

  ///</returns>

  /// </summary>

  static int Summation(int val) {

    int result = 0;

    for (int i = 1; i <= val; i++)

      result += i;

    return result;

  }

}

Если текст приведенной выше программы содержится в файле XmlTest.cs, то по следующей команде будет скомпилирована программа и получен файл XmlTest.xml, содержащий комментарии к ней.

csc XmlTest.cs /doc:XmlTest.xml

После компилирования получается XML-файл, содержимое которого приведено ниже.

<?xml version="1.0"?>

<doc>

    <assembly>

        <name>Program</name>

    </assembly>

    <members>

        <member name="T:Test">

            <remark>

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

            В классе Test демонстрируется ряд дескрипторов.

            </remark>

        </member>

        <member name="M:Test.Main">

            <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.

Предметный указатель

(Удален. Все-равно номеров страниц нет. См. Оригинал)

Спецификации

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

Все названия программных продуктов являются зарегистрированными торговыми марками соответствующих фирм.

Научно-популярное издание Герберт Шилдт C# 4.0: полное руководство

Литературный редактор Е.П. Перестюк

Верстка А.В. Чернокозинская Художественный редактор С А. Чернокозинский Корректор АЛ. Гордиенко

Подписано в печать 17.09.2010. Формат 70x100/16. Гарнитура Times. Печать офсетная.

Уел. печ. л. 85,14. Уч.-изд. л. 51,55.

Тираж 1500 экз. Заказ № 24007.

Отпечатано по технологии CtP в ОАО "Печатный двор" им. А. М. Горького 197110, Санкт-Петербург, Чкаловский пр., 15.