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

Компилятор Visual Basic может обрабатывать комментарии документации в коде в XML-файле.The Visual Basic compiler can process documentation comments in your code to an XML file. Для обработки XML-файла в документации можно использовать дополнительные средства.You can use additional tools to process the XML file into documentation.

Комментарии XML разрешены в конструкциях кода, таких как типы и члены типов.XML comments are allowed on code constructs such as types and type members. Для разделяемых типов только одна часть типа может содержать комментарии XML, хотя не существует ограничений на комментирование его элементов.For partial types, only one part of the type can have XML comments, although there is no restriction on commenting its members.

Примечание

Комментарии к документации нельзя применять к пространствам имен.Documentation comments cannot be applied to namespaces. Причина состоит в том, что одно пространство имен может охватывать несколько сборок, и не все сборки должны быть загружены одновременно.The reason is that one namespace can span several assemblies, and not all assemblies have to be loaded at the same time.

Компилятор обрабатывает любой тег, который является допустимым XML.The compiler processes any tag that is valid XML. Следующие теги предоставляют часто используемые функции в пользовательской документации.The following tags provide commonly used functionality in user documentation.

<c><c> <code><code> <example><example>
исключение<> 1<exception> 1 <включить > 1<include> 1 <list><list>
<para><para> <param > 1<param> 1 <paramref><paramref>
<разрешение > 1<permission> 1 <remarks><remarks> <returns><returns>
<см. > 1<see> 1 <seealso > 1<seealso> 1 <summary><summary>
<typeparam > 1<typeparam> 1 <value><value>

(1 компилятор проверяет синтаксис.)(1 The compiler verifies syntax.)

Примечание

Если необходимо, чтобы угловые скобки отображались в тексте комментария к документации, используйте &lt; и &gt;.If you want angle brackets to appear in the text of a documentation comment, use &lt; and &gt;. Например, строка "&lt;text in angle brackets&gt;" будет выглядеть как <text in angle brackets>.For example, the string "&lt;text in angle brackets&gt;" will appear as <text in angle brackets>.

См. такжеSee also