Документирование кода с помощью XML (Visual Basic)
В Visual Basic можно документировать код с помощью XML
Комментарии к XML-документации
Visual Basic предоставляет простой способ автоматического создания XML–документации для проектов.Можно автоматически создавать XML–схему для типов и членов, а затем можно указать сводку, описательную документацию для каждого параметра и другие примечания.С соответствующей настройкой XML–документация автоматически генерируется в XML–файл с тем же именем, что и проект, и расширением XML.Дополнительные сведения см. в разделе /doc.
XML–файл можно использовать или обрабатывать каким–либо иным способом.Этот файл расположен в том же каталоге, что и выходные файлы EXE или DLL проекта.
XML–документация начинается с '''.Обработка этих комментариев имеет некоторые ограничения:
Документация должна представлять собой XML с правильным форматом.Если XML не имеет правильный формат, выдается предупреждение и файл документации будет содержать комментарий о том, что произошла ошибка.
Разработчики могут создавать свои собственные наборы тегов.Здесь представлен рекомендуемый набор тегов (см. "Дополнительные сведения" в этом разделе).Некоторые рекомендуемые теги имеют специальное значение.
Тег <param> используется для описания параметров.При его использовании компилятор должен убедиться в том, что параметр существует и что все параметры описаны в документации.При сбое проверки компилятор выдает предупреждение.
Атрибут cref может быть присоединен к любому тегу для предоставления ссылки на элемент кода.Компилятор проверяет, что этот элемент кода существует.При сбое проверки компилятор выдает предупреждение.Компилятор также соблюдает любые операторы Imports при поиске типа, описанного в атрибуте cref.
Тег <summary> используется технологией IntelliSense в Visual Studio для отображения дополнительных сведений о типе или элементе.
Связанные разделы
Дополнительные сведения о создании файла XML с комментариями документации содержатся в следующих разделах:
Рекомендуется использовать XML-теги для комментариев документации (Visual Basic)
Практическое руководство. Создание XML-документации в Visual Basic