Прочитать на английском

Поделиться через

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

  • Статья

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

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

Примечание

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

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

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

Примечание

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

См. также