>

>  имя_элемента

>  текст

>

где текст описывает имя_элемента. Для описания маркированных и нумерованных списков, а также таблиц имя элемента не используется. Допускается применение нескольких элементов списка .

Таблица 1. Дескрипторы XML-комментариев

Дескриптор - Описание

<с> код - Определяет текст, на который указывает код, как программный код

код - Определяет несколько строк текста, на который указывает код, как программный код

пояснение - Определяет текст, на который указывает пояснение, как описание примера кода

пояснение - Описывает исключительную ситуацию, на которую указывает имя

- Определяет файл, содержащий XML-комментарии для текущего исходного файла. При этом fname обозначает имя файла; path — путь к файлу; tagName — имя дескриптора; tagID — идентификатор дескриптора

заголовок списка элементы списка - Определяет список. При.этом тип обозначает тип списка, который может быть маркированным, нумерованным или таблицей

<рага> текст - Определяет абзац текста в другом дескрипторе

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

- Обозначает имя параметра как имя конкретного параметра

пояснение - Описывает параметр разрешения, связанный с

членами класса, на которые указывает идентификатор. Текст, обозначаемый как пояснение, описывает параметры разрешения

пояснение - Текст, обозначаемый как пояснение, представляет собой общие комментарии, которые часто используются для описания класса или структуры

пояснение - Текст, обозначаемый как пояснение, описывает значение, возвращаемое методом

- Объявляет ссылку на другой элемент, обозначаемый как идентификатор

- Объявляет ссылку типа “см. также" на идентификатор

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

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

Для получения XML-файла, содержащего документирующие комментарии, достаточно указать параметр /doc в командной строке компилятора. Например, для компилирования файла DocTest.cs, содержащего XML-комментарии, в командной строке необходимо ввести следующее.

>csc DocTest.cs /doc:DocTest.xml

Для вывода результата в XML-файл из интегрированной среды разработки Visual Studio необходимо активизировать окно