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


/doc (обработка комментариев документации) (C/C++)

Вызывает компилятор, чтобы обработать комментарии документации в файлах источника кода, и создает XDC-файл для каждого файла с исходным кодом, в котором есть комментарии к документации.

/doc[name]

Аргументы

  • name
    Имя XDC-файла, который будет создан компилятором.Только корректный CPP-файл передается для компиляции.

Заметки

XDC-файлы выполняются в XML-файле при помощи xdcmake.exe.Дополнительные сведения см. в разделе XDCMake Reference.

Можно добавить комментарии документации в файл с исходным кодом.Дополнительные сведения см. в разделе Recommended Tags for Documentation Comments (Visual C++).

Параметр /doc несовместим с параметром /clr:oldSyntax.Дополнительные сведения см. в разделе /clr (компиляция CLR).

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

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

  1. Откройте диалоговое окно Страницы свойств проекта.Дополнительные сведения см. в разделе Открытие свойств страниц проекта.

  2. Разверните узел Свойства конфигурации.

  3. Разверните узел C/C++.

  4. Щелкните страницу свойств Выходные файлы.

  5. Измените свойство Создать файлы XML-документации.

Установка данного параметра компоновщика программным способом

См. также

Ссылки

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

Настройка параметров компилятора