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

/doc

  • Статья

Обрабатывает комментарии для документации и помещает их в XML-файл.

/doc[+ | -]
' -or-
/doc:file

Аргументы

Термин

Определение

+ | -

Необязательный. Указание + или просто /doc указывает компилятору сгенерировать сведения о документации и поместить их в XML-файл. Указание - является эквивалентом неуказанного /doc, не вызывает создание сведений о документации.

file

Обязателен, если используется /doc:. Задает выходной файл XML, который заполняется комментариями из файлов исходного кода компиляции. Если имя файла содержит пробелы, заключайте имя в кавычки (" ").

Заметки

Параметр /doc указывает, создавать ли компилятору XML-файл, содержащий комментарии документации. Если используется синтаксис /doc:file, параметр file задает имя XML-файла. Если используется /doc или /doc+, компилятор принимает имя XML-файла из исполняемого файла или библиотеки, создаваемой компилятором. При использовании /doc- или, если параметр /doc не задан, компилятор не создает XML-файл.

В файлах исходного кода комментариям документации могут предшествовать следующие определения.

Чтобы использовать созданный Visual Studio XML-файл при помощи функции IntelliSense, имя XML-файла должно совпадать с именем сборки, для которой требуется поддержка. Убедитесь, что XML-файл находится в той же папке, что сборка, таким образом, чтобы при ссылке на сборку в проекте Visual Studio XML-файл был найден. XML-файлы документации не требуются IntelliSense для работы с кодом в проекте или в проектах, на которые ссылается проект.

Если при компиляции не указать /target:module, то XML-файл будет содержать теги <assembly></assembly>. Эти теги указывают имя файла, содержащего манифест сборки для выходного файла компиляции.

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

Установка параметра /doc в интегрированной среде разработки Visual Studio

  1. Выберите проект в обозревателе решений. В меню Проект выберите пункт Свойства. Дополнительные сведения см. в разделе Знакомство с конструктором проектов.

  2. Перейдите на вкладку Compile.

  3. Задайте значение в поле Создать XML-файл документации.

Пример

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

См. также

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

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

Другие ресурсы

Компилятор Visual Basic