/doc (Procesar comentarios de documentación) (Opciones del compilador de C#)
Actualización: noviembre 2007
La opción /doc permite insertar comentarios de documentación en un archivo XML.
/doc:file
Argumentos
- file
Archivo de resultados para XML, que se llena con los comentarios de los archivos del código fuente de la compilación.
Comentarios
En los archivos de código fuente, pueden procesarse y agregarse al archivo XML los comentarios de documentación que preceden a los citados a continuación:
Tipos definidos por el usuario como una clase, un delegado o una interfaz
Miembros como un campo, un evento, una propiedad o un método.
El código fuente que contiene Main es el primero que se extrae al archivo XML.
Para utilizar el archivo .xml generado junto con la característica IntelliSense, dé el mismo nombre al archivo .xml que al ensamblado que con el desee tener compatibilidad, y asegúrese de que ambos estén en el mismo directorio. Así, cuando se haga referencia al ensamblado en el proyecto de Visual Studio, también se encontrará el archivo .xml. Vea Proporcionar comentarios al código para obtener más información.
A no ser que compile con /target:module, file contendrá las etiquetas <assembly></assembly>, que especifican el nombre del archivo que contiene el manifiesto del ensamblado del archivo de resultados de la compilación.
.gif "Nota") Nota: |
|---|
La opción /doc se aplica a todos los archivos de entrada; o bien, si se ha establecido en la configuración del proyecto, a todos los archivos en el proyecto. Para deshabilitar las advertencias relacionadas con los comentarios de documentación de un archivo o sección de código en particular, utilice #pragma warning. |
Vea Etiquetas recomendadas para comentarios de documentación para conocer los modos de generar documentación a partir de los comentarios del código.
Vea Ejemplo XML Documentation para obtener un ejemplo.
Para establecer esta opción del compilador en el entorno de desarrollo de Visual Studio
Abra la página Propiedades del proyecto.
Modifique la propiedad Archivo de documentación XML.
Para obtener información sobre cómo establecer esta opción del compilador mediante programación, vea DocumentationFile.