Documentación XML (Visual C++)

  • Artículo

En Visual C++, se pueden agregar comentarios al código fuente que se procesarán en un archivo de documentación XML. Después, este archivo puede ser la entrada para un proceso que crea la documentación para las clases del código.

En un archivo de código de Visual C++, los comentarios de documentación XML deben encontrarse directamente antes de una definición de tipo o método. Los comentarios se pueden usar para rellenar la información sobre datos de Información rápida de IntelliSense en los escenarios siguientes:

  1. Cuando el código se compila como un componente de Windows Runtime con un archivo WINMD.

  2. Cuando el código fuente se incluye en el proyecto actual.

  3. En una biblioteca cuyas declaraciones e implementaciones de tipos se encuentran en el mismo archivo de encabezado.

Nota:

En la versión actual, los comentarios de código no se procesan en plantillas ni en nada que contenga un tipo de plantilla (por ejemplo, una función que toma un parámetro como plantilla). Agregar estos comentarios producirá un comportamiento no definido.

Para más información sobre cómo crear un archivo XML con los comentarios de documentación, consulte los artículos siguientes.

Para información acerca de Vea
Las opciones del compilador que se van a usar. /doc
Las etiquetas que se pueden usar para proporcionar funciones de uso general en la documentación. Etiquetas recomendadas para los comentarios de documentación
Las cadenas de identificador que el compilador genera para identificar las construcciones en el código. Procesamiento del archivo XML
Cómo delimitar las etiquetas de documentación Delimitadores para etiquetas de documentación en Visual C++
Generación de un archivo XML a partir de uno o más archivos XDC. Referencia de XDCMake
Vínculos a información sobre XML en relación con las áreas de características de Visual Studio XML en Visual Studio

Si tiene que colocar caracteres especiales de XML en el texto de un comentario de documentación, debe usar entidades XML o una sección CDATA.

Consulte también

Extensiones de componentes para plataformas de tiempo de ejecución