XML-документация (Visual C++)

В Visual C++можно добавить комментарии в исходный код, обрабатываемый в XML-файл документации. Затем этот файл можно использовать в качестве входного для процесса, создающего документацию для классов в коде.

В файле кода Visual C++ комментарии к XML-документации должны находиться непосредственно перед определением метода или типа. Комментарии можно использовать для заполнения подсказок по данным для кратких сведений IntelliSense в следующих сценариях:

1. Когда код компилируется как компонент среда выполнения Windows с файлом WINMD

2. Если исходный код включен в текущий проект

3. В библиотеке, объявления типов и реализации которой находятся в том же файле заголовка

Примечание.

В текущем выпуске комментарии кода не обрабатываются в шаблонах или ничего, содержащего тип шаблона (например, функция, принимаюющая параметр в качестве шаблона). Добавление таких комментариев приведет к неопределенному поведению.

Дополнительные сведения о создании XML-файла с комментариями документации см. в следующих статьях.

Сведения	Смотрите
Используемые параметры компилятора	/doc
Теги, позволяющие реализовать часто используемые функции в документации	Рекомендуемые теги для комментариев документации
Строки идентификаторов, создаваемые компилятором для идентификации конструкций в коде	Обработка XML-файла
Разделение тегов документации	Разделители для тегов документации по Visual C++
Создание XML-файла из одного или нескольких XDC-файлов.	Справочник по XDCMake
Ссылки на сведения об XML, посвященные связи с областями компонентов Visual Studio	XML в Visual Studio

Если вам нужно поместить специальные символы XML в текст комментария документации, следует использовать сущности XML или раздел CDATA.

См. также

Расширения компонентов для платформ среды выполнения