Se recomienda usar Visual Studio 2017

Documentación XML (Visual C++)

 

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

En Visual C++, puede agregar comentarios al código fuente que se procesará un archivo .xml. Este archivo puede ser la entrada a un proceso que cree la documentación para las clases del código.

En un archivo de código de Visual C++, los Comentarios de documentación XML se deben encontrar directamente antes de un método o definición de tipo. Los comentarios se pueden usar para rellenar la sugerencia de datos Intellisense QuickInfo en los escenarios siguientes:

  1. cuando el código se compila como un componente en tiempo de ejecución de Windows con un archivo de acompañamiento de .winmd

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

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

System_CAPS_ICON_note.jpg Nota

En la versión actual, los comentarios de código no se procesan en plantillas o nada que contiene un tipo de plantilla (por ejemplo, una función que toma un parámetro como plantilla). Agregar estos comentarios dará lugar a un comportamiento indefinido.

Para obtener información sobre cómo crear un archivo .xml con comentarios de documentación, vea los temas siguientes.

Para obtener más información sobreVea
Las opciones del compilador para usar/doc
Etiquetas que puede utilizar para proporcionar funcionalidad de uso frecuente en la documentaciónEtiquetas recomendadas para comentarios de documentación
Las cadenas de identificación que el compilador genera para identificar las construcciones del códigoProcesar el archivo .xml
Cómo delimitar etiquetas de la documentaciónDelimitadores para las etiquetas de la documentación de Visual C++
Generar un archivo .xml de uno o más archivos .xdc.Referencia de XDCMake
Vínculos a información sobre XML respecto a las áreas de características de Visual StudioXML en Visual Studio

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

Extensiones de componentes para plataformas de tiempo de ejecución

Mostrar: