/doc (обработка комментариев документации) (C/C++)
Компилятор обрабатывает комментарии документации в файлах исходного кода и создает XDC-файл для каждого файла исходного кода с комментариями к документации.
Синтаксис
/doc[name]
Аргументы
имя
Имя XDC-файла, создаваемого компилятором. Допустимо только в том случае, если один CPP-файл передается в компиляции.
Замечания
Файлы XDC обрабатываются в XML-файл с xdcmake.exe. Дополнительные сведения см. в справочнике по XDCMake.
Вы можете добавить комментарии к документации в файлы исходного кода. Дополнительные сведения см. в разделе Рекомендуемые теги для комментариев документации.
Чтобы использовать созданный XML-файл с IntelliSense, сделайте имя файла XML-файла таким же, как сборка, которую требуется поддерживать, и поместите XML-файл в тот же каталог, что и сборка. При ссылке на сборку в проекте Visual Studio также найден XML-файл. Дополнительные сведения см. в разделе "Использование IntelliSense " и "Предоставление комментариев XML-кода".
Установка данного параметра компилятора в среде разработки Visual Studio
Откройте диалоговое окно Страницы свойств проекта. Подробнее см. в статье Настройка компилятора C++ и свойства сборки в Visual Studio.
Перейдите на страницу свойств Свойства конфигурации>C/C++>Выходные файлы.
Измените свойство Generate XML Documentation Files .
Задание данного параметра компоновщика программным способом
- См. раздел GenerateXMLDocumentationFiles.
См. также
Параметры компилятора MSVC
Синтаксис командной строки компилятора MSVC
Обратная связь
https://aka.ms/ContentUserFeedback.
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделеОтправить и просмотреть отзыв по