Примечание
Для доступа к этой странице требуется авторизация. Вы можете попробовать войти или изменить каталоги.
Для доступа к этой странице требуется авторизация. Вы можете попробовать изменить каталоги.
Компилятор Visual Basic может обрабатывать комментарии документации в коде в XML-файле. Дополнительные средства можно использовать для обработки XML-файла в документацию.
Примечания XML допускаются для конструкций кода, таких как типы и члены типов. Для частичных типов только одна часть типа может иметь XML-комментарии, хотя нет ограничений на комментарии его членов.
Замечание
Комментарии к документации нельзя применить к пространствам имен. Причина в том, что одно пространство имен может охватывать несколько сборок, а не все сборки должны загружаться одновременно.
Компилятор обрабатывает любой тег, который является допустимым XML. Следующие теги предоставляют часто используемые функции в пользовательской документации.
- <c>
- <код>
- <пример>
- <исключение>1
- <include>1
- <список>
- <Пункт>
- <param>1
- <paramref>
- <разрешение>1
- <Замечания>
- <Возвращает>
- <см>. 1
- <seealso>1
- <сводка>
- <typeparam>1
- <значение>
(1 Компилятор проверяет синтаксис.)
Замечание
Если вы хотите, чтобы угловые скобки отображались в тексте комментария документации, используйте < и >. Например, строка "<text in angle brackets>" будет отображаться как <text in angle brackets>.
См. также
Совместная работа с нами на GitHub
Источник этого содержимого можно найти на GitHub, где также можно создавать и просматривать проблемы и запросы на вытягивание. Дополнительные сведения см. в нашем руководстве для участников.
