Рекомендуемые теги для комментариев документации
Компилятор MSVC обрабатывает комментарии документации в коде, чтобы создать XDC-файл для каждого скомпилированного исходного файла. Затем xdcmake.exe обрабатывает XDC-файлы для создания XML-файла документации. Обработка XML-файла для создания документации — это подробные сведения, которые необходимо реализовать на сайте.
Теги обрабатываются в конструкциях, таких как типы и их члены.
Теги должны стоять прямо перед типами или членами.
Примечание.
Комментарии к документации нельзя применять к пространству имен или вне определений строк для свойств и событий; Комментарии к документации должны находиться в объявлениях в классе.
Компилятор обрабатывает любые теги, имеющие допустимый формат XML. С помощью следующих тегов реализуются часто используемые в пользовательской документации возможности:
<c>
<code>
<example>
<exception>
1
<include>
1
<list>
<para>
<param>
1
<paramref>
1
<permission>
1
<remarks>
<returns>
<see>
1
<seealso>
1
<summary>
<value>
- Компилятор проверяет синтаксис.
В текущем выпуске компилятор MSVC не поддерживает <paramref>
тег, поддерживаемый другими компиляторами Visual Studio. Возможно, поддержка <paramref>
будет добавлена в будущих выпусках Visual C++.
См. также
Обратная связь
https://aka.ms/ContentUserFeedback.
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделеОтправить и просмотреть отзыв по