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

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

В Visual Basic можно задокументируйте код с помощью XML.

Комментарии XML-документации

Visual Basic предоставляет простой способ автоматического создания XML-документации для проектов. Вы можете автоматически создать структуру XML для типов и членов, а затем предоставить сводки, описательную документацию для каждого параметра и другие примечания. При правильной настройке XML-документация автоматически выводится в XML-файл с тем же корневым именем файла, что и ваш проект. Для получения информации о настройке генерации XML-файла документации см. опция компилятора -doc и свойство MSBuild GenerateDocumentationFile.

XML-файл можно использовать или иначе взаимодействовать с ним как с XML. Этот файл находится в том же каталоге, что и выходной .exe или файл .dll проекта.

XML-документация начинается с '''. Обработка этих комментариев имеет некоторые ограничения:

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

  • Разработчики могут создавать собственный набор тегов. Существует рекомендуемый набор тегов (см. теги комментариев XML). Некоторые рекомендуемые теги имеют особые значения.

    • <Тег param> используется для описания параметров. При использовании компилятор проверяет наличие параметра и описание всех параметров в документации. Если проверка завершается ошибкой, компилятор выдает предупреждение.

    • Атрибут cref может быть присоединен к любому тегу для предоставления ссылки на элемент кода. Компилятор проверяет, существует ли этот элемент кода. Если проверка завершается ошибкой, компилятор выдает предупреждение. Компилятор также принимает во внимание любые Imports инструкции при поиске типа, указанного в атрибуте cref.

    • Тег <сводки> используется в IntelliSense Visual Studio для отображения дополнительной информации о типе или элементе.

Дополнительные сведения о создании XML-файла с комментариями документации см. в следующих разделах:

См. также