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

  • Статья

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

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

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

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

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

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

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

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

    • Атрибут cref может быть присоединен к любому тегу для предоставления ссылки на элемент кода. Компилятор проверяет наличие этого элемента кода. При сбое проверки компилятор выдает предупреждение. Компилятор также учитывает все Imports операторы при поиске типа, описанного в атрибуте cref .

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

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

См. также