Etiquetas recomendadas para comentarios de documentación (Visual C++)

 

Para obtener la documentación más reciente de Visual Studio 2017 RC, consulte Documentación de Visual Studio 2017 RC.

El compilador de Visual C++ procesará comentarios de documentación en el código y crea un archivo .xdc para cada compilación, y xdcmake.exe procesará archivos .xdc a un archivo .xml. Procesar el archivo .xml para crear documentación es un detalle que necesita implementar en el sitio.

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

Las etiquetas deben inmediatamente anterior a tipos o miembros.

System_CAPS_ICON_note.jpg Nota

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

El compilador procesará cualquier etiqueta válida en XML. Las etiquetas siguientes proporcionan funcionalidad de uso frecuente 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 sintaxis.

En la versión actual, el compilador de Visual C++ no admite <paramref>, una etiqueta admitida por otros compiladores de Visual Studio. Visual C++ puede admitir <paramref> en futuras versiones.

Documentación de XML

Mostrar: