Бөлісу құралы:

-доктор

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

Синтаксис

-doc[+ | -]

или

-doc:file

Аргументы

Срок Определение
+ | - Необязательно. При указании +или просто -docкомпилятор создает сведения о документации и помещает его в XML-файл. Указание - эквивалентно не указанию -doc, что приводит к отсутствии сведений о документации.
file Обязательный, если -doc: используется. Указывает выходной XML-файл, заполненный комментариями из файлов исходного кода компиляции. Если имя файла содержит пробел, заключите имя кавычками ("").

Замечания

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

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

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

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

Сведения о способах создания документации из комментариев в коде см. в тегах комментариев XML .

Установка -doc в интегрированной среде разработки Visual Studio
1. Выбор проекта в обозревателе решений. В меню Проект выберите пункт Свойства.
2. Щелкните вкладку "Компиляция ".
3. Задайте значение в поле "Создание XML-документации ".

Пример

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

См. также

  • Last updated on