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

Рекомендуемые теги для комментариев документации (Visual C++)

  • Статья

Компилятор Visual C++ будет C - процесс документирующие комментарии в коде и создает файл .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>

 

 

1.Компилятор проверяет синтаксис.

В текущем выпуске, компилятор Visual C++ не поддерживает <paramref>, тега, поддерживаемый другими компиляторами Visual Studio.Visual C++ может поддерживать C <paramref> в будущих выпусках.

См. также

Другие ресурсы

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