Рекомендуется использовать XML-теги для комментариев документации (Visual Basic)

Обновлен: Ноябрь 2007

Компилятор Visual Basic может обрабатывать документацию комментариев в коде в XML-файл. Можно использовать дополнительные средства для обработки XML-файла в документации.

Комментарии XML разрешены в конструкциях кода, таких как типы и члены типов. Для разделяемых типов только одна часть типа может содержать комментарии XML, однако нет никаких ограничений на комментирование его членов.

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

Компилятор обрабатывает любой тег, который является допустимым тегом XML. Следующие теги предоставляют часто используемые возможности в пользовательской документации.

<c>	<code>	<example>
<exception>1	<include>1	<list>
<para>	<param>1	<paramref>
<permission>1	<remarks>	<returns>
<see>1	<seealso>1	<summary>
<typeparam>1	<value>

(1 Синтаксис проверяется компилятором.)

Примечание.
Чтобы вставить угловые скобки в текст комментария документации, используйте &lt; и &gt;. Например, строка "&lt;text in angle brackets&gt;" будет выглядеть как <text in anglebrackets>.

См. также

Задачи

Практическое руководство. Создание XML-документации в Visual Basic

Основные понятия

Документирование кода с помощью XML (Visual Basic)

Ссылки

/doc