/doc (параметры компилятора C#)

Параметр /doc позволяет поместить комментарии документации в XML-файл.

/doc:file

Аргументы

• file
  Выходной XML-файл, который заполняется комментариями из файлов исходного кода, участвующих в компиляции.

Заметки

Комментарии документации могут быть обработаны и добавлены в XML-файл, если они предшествуют объектам файлов исходного кода, перечисленным ниже.

• Такие определяемые пользователем типы, как класс, делегат или интерфейс

• Такие члены, как событие, свойство или метод

Файл исходного кода, содержащий метод "Main" первым выводится в XML-файл.

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

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

Примечание
Параметр /doc применяется ко всем входным файлам или (если он установлен в параметрах проекта) ко всем файлам проекта.Чтобы отключить предупреждения, связанные с комментариями документации для определенного файла или раздела кода, используйте директиву #pragma warning.

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

Установка данного параметра компилятора в среде разработки Visual Studio

1. Откройте страницу Свойства проекта.

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

3. Измените свойство Файл XML-документации.

Дополнительные сведения об установке этого параметра компилятора программным путем см. в разделе DocumentationFile.

См. также

Задачи

Практическое руководство. Изменение свойств проекта и параметров конфигурации

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

Параметры компилятора C#