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

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

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

Замечание

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

Чтобы создать XML-документацию для типа или члена

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

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

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

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

    Замечание

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

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

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

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

См. также