/doc (Procesar comentarios de documentación) (C/C++)

  • Artículo

Hace que el compilador procese los comentarios de documentación en los archivos de código fuente y cree un archivo .xdc para cada archivo de código fuente que tenga comentarios de documentación.

Sintaxis

/doc[name]

Argumentos

name
Nombre del archivo .xdc que creará el compilador. Solo es válido cuando se pasa un archivo .cpp en la compilación.

Comentarios

Los archivos .xdc se procesan en un archivo .xml con xdcmake.exe. Para obtener más información, vea Referencia de XDCMAKE.

Puede agregar los comentarios de documentación a los archivos de código fuente. Para más información, consulte Etiquetas recomendadas para los comentarios de documentación.

Para usar el archivo .xml generado con la función IntelliSense, haga que el nombre del archivo .xml sea igual que el del ensamblado que quiere admitir y, después, ponga el archivo .xml en el mismo directorio que el ensamblado. Cuando se hace referencia al ensamblado en el proyecto de Visual Studio, se encuentra también el archivo .xml. Para obtener más información, vea Uso de IntelliSense y Proporcionar comentarios del código XML.

Para establecer esta opción del compilador en el entorno de desarrollo de Visual Studio

  1. Abra el cuadro de diálogo Páginas de propiedades del proyecto. Para más información, vea Establecimiento del compilador de C++ y de propiedades de compilación en Visual Studio.

  2. Seleccione la página de propiedades Propiedades de configuración>C/C++>Archivos de salida.

  3. Modifique la propiedad Generar archivos de documentación XML.

Para establecer esta opción del vinculador mediante programación

Consulte también

Opciones del compilador de MSVC
Sintaxis de la línea de comandos del compilador MSVC