Compartir a través de


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

Provoca que el compilador procese comentarios de documentación en archivos de código fuente, y la creación de un archivo .xdc por cada archivo de código fuente que tenga comentarios de documentación.

/doc[name]

Argumentos

  • name
    El nombre del archivo .xdc que creará el compilador. Sólo 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 XDCMake (Referencia).

Puede agregar los comentarios de documentación a sus archivos de código fuente. Para obtener más información, vea Etiquetas recomendadas para comentarios de documentación (Visual C++).

/doc no es compatible con /clr:oldSyntax. Vea /clr (Compilación de Common Language Runtime) para obtener más información.

Para utilizar el archivo .xml generado con IntelliSense, haga coincidir el nombre del archivo .xml con el del ensamblado que desea admitir y ponga el archivo .xml en el mismo directorio que el ensamblado. Cuando se haga referencia al ensamblado en el proyecto de Visual Studio, también se encontrará el archivo .xml. Para obtener más información, vea Utilizar 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 obtener información detallada, vea Cómo: Abrir páginas de propiedades del proyecto.

  2. Expanda el nodo Propiedades de configuración.

  3. Expanda el nodo C/C++.

  4. Seleccione la página de propiedades Archivos de resultados.

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

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

Vea también

Referencia

Opciones del compilador

Establecer las opciones del compilador