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

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

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

Замечание

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

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

• <c>
• <код>
• <пример>
• <исключение>¹
• <include>¹
• <список>
• <Пункт>
• <param>¹
• <paramref>
• <разрешение>¹
• <Замечания>
• <Возвращает>
• <см>^{. 1}
• <seealso>¹
• <сводка>
• <typeparam>¹
• <typeparamref>
• <значение>

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

Замечание

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

См. также

• Документирование кода с помощью XML
• -документ
• Практическое руководство. Создание XML-документации