Share via

Etiquetas recomendadas para los comentarios de la documentación

  • Artículo

El compilador de MSVC procesa los comentarios de documentación en el código para crear un archivo XDC para cada archivo de código fuente compilado. A continuación, xdcmake.exe procesa los archivos XDC para crear un archivo de documentación XML. El procesamiento del archivo XML para crear documentación es un detalle que se debe implementar en el sitio.

Las etiquetas se procesan en construcciones como los tipos y miembros de tipo.

Las etiquetas deben preceder inmediatamente a los tipos o miembros.

Nota:

Los comentarios de documentación no se pueden aplicar a un espacio de nombres o en una definición fuera de línea para las propiedades y los eventos; deben estar en las declaraciones de clase.

El compilador procesará cualquier etiqueta que sea un XML válido. Las etiquetas siguientes proporcionan funciones de uso general en la documentación de usuario:

<c>
<code>
<example>
<exception>1
<include>1
<list>
<para>
<param>1
<paramref>1
<permission>1
<remarks>
<returns>
<see>1
<seealso>1
<summary>
<value>

  1. El compilador comprueba la sintaxis.

En la versión actual, el compilador de Visual C++ no admite <paramref>, una etiqueta compatible con otros compiladores de Visual Studio. Visual C++ puede admitir <paramref> en una versión futura.

Consulte también

Documentación de XML