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

  • Статья

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

Синтаксис

/doc[name]

Аргументы

name
Имя XDC-файла, создаваемого компилятором. Допустимо только в том случае, если в компиляции передается один .cpp-файл.

Замечания

Файлы XDC обрабатываются в файл .xml с xdcmake.exe. Дополнительные сведения см. в справочнике по XDCMake.

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

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

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

  1. Откройте диалоговое окно Страницы свойств проекта. Подробнее см. в статье Настройка компилятора C++ и свойства сборки в Visual Studio.

  2. Перейдите на страницу свойств Свойства конфигурации>C/C++>Выходные файлы.

  3. Измените свойство Generate XML Documentation Files .

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

См. также

Параметры компилятора MSVC
Синтаксис командной строки компилятора MSVC