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

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

  • Статья

В этом примере показано, как добавить комментарии xml-документации в код.

Примечание.

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

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

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

  2. Тип ''' (три одинарные кавычки).

    В редакторе кода добавляется структура XML для типа или члена.

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

    Примечание.

    При добавлении дополнительных строк в блоке документации XML каждая строка должна начинаться с '''.

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

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

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

См. также