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

Практическое руководство. Создание XML-документации в Visual Basic

  • Статья

В этом примере демонстрируется добавление комментариев XML-документации в код.

Примечание

На вашем компьютере названия некоторых элементов интерфейса пользователя Visual Studio или их расположение могут отличаться от указанных в нижеследующих инструкциях. Это зависит от имеющегося выпуска Visual Studio и используемых параметров. Дополнительные сведения см. в разделе Параметры Visual Studio.

Создание XML-документации для типа или члена

  1. В редакторе кода поместите курсор на одну строку выше типа или члена, для которого требуется создать документацию.

  2. Введите ''' (три знака одинарных кавычек).

    Схема XML для типа или члена добавляется в редактор кода.

  3. Добавьте описательные сведения между соответствующими тегами.

    Примечание

    Чтобы добавить дополнительные строки внутри блока XML-документации, следует начинать каждую строку с кавычек '''.

  4. Добавьте дополнительный код, который использует тип или член с новыми комментариями XML-документации.

    IntelliSense отображает текст из тега <summary> для типа или члена.

  5. Скомпилируйте код для создания XML-файла, содержащего комментарии документации. Дополнительные сведения см. в разделе /doc.

См. также

Ссылки

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

/doc

Основные понятия

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