Тег Описание

<С> Форматирование как фрагмента кода

<code> Многострочный код (используется в секции <example>)

<examplе> Пример использования класса или метода

<exception> Исключение, генерируемое классом

<include filе=' файл' Ссылка на комментарии в другом файле, в котором

path='путь[@пате="ид"]' ' /> находятся описания элементов исходного кода

<list> Перечисление в виде списка

<рагаm> Описание параметра метода

<paramref> Ссылка на параметр

<permission> Права доступа к элементу

<remarks> Подробное описание элемента (класса, метода и т. п.)

<returns> Возвращаемое значение метода

<see cref="элемент"> Ссылка на элемент класса

<seealso cref ="элемент"> Ссылка на документацию вида «см. также»

<summary> Краткое описание элемента (класса, метода и т. п.)

<value> Описание значения свойства

Примеры тегов:

///<summary> Функция вычисления синуса </summary>

///<param name="i"> Аргумент функции </param>

///<seealso cref="System.Double"> double </seealso>

///<returns> Возвращает величину синуса </returns>

///<remarks> Для вычислений используется разложение

///в ряд Тейлора </remarks>

public double Sin(double i){...}

Для построения файлов документации в формате XML требуется использовать режим компиляции /dос:имя_файла.xml. Этот режим можно установить и в среде Visual Studio в окне свойств проекта (Project ► Properties) на вкладке Build (задать имя файла XML documentation file). Компилятор проверяет правильность записи тегов и их соответствие элементам программы.

ПРИМЕЧАНИЕ

В Visual Studio 2003 для построения файлов документации в формате HTML ис­пользуется команда меню Tools ► Build Comment Web Pages.

Темы, не рассмотренные в книге

Эта книга заканчивается там, где начинается самое интересное — профессиональ­ное применение С#: создание веб-форм и веб-служб, распределенных приложений, работа с базами данных с помощью ADO.NET и т. д. Этим вопросам посвящены
тысячи страниц книг и документации, а здесь приводится краткое введение для того, чтобы облегчить вам выбор материала для дальнейшего изучения.