-doc

  • Artículo

Procesa los comentarios de documentación generando un archivo XML.

Sintaxis

-doc[+ | -]

o

-doc:file

Argumentos

Término Definición
+ | - Opcional. Si se especifica + o solo -doc, el compilador genera información de documentación y la coloca en un archivo XML. Especificar - es el equivalente a no especificar -doc, lo que causa que no se cree ninguna información de documentación.
file Es necesario si se usa -doc:. Especifica el archivo XML de salida, que se rellena con los comentarios de los archivos de código fuente de la compilación. Si el nombre de archivo contiene un espacio, escríbalo entre comillas (" ").

Comentarios

La opción -doc controla si el compilador genera un archivo XML que contiene los comentarios de documentación. Si usa la sintaxis -doc:file, el parámetro file especifica el nombre del archivo XML. Si usa -doc o -doc+, el compilador toma el nombre del archivo XML desde el archivo ejecutable o la biblioteca que el compilador va a crear. Si usa -doc- o no especifica la opción -doc, el compilador no crea un archivo XML.

En los archivos de código fuente, los comentarios de documentación pueden preceder a las siguientes definiciones:

Para usar el archivo XML generado con la característica IntelliSense de Visual Studio, deje que el nombre del archivo XML sea igual que el del ensamblado que quiere admitir. Asegúrese de que el archivo XML se encuentra en el mismo directorio que el ensamblado, para que cuando se haga referencia al ensamblado en el proyecto de Visual Studio, también se encuentre el archivo .xml. Los archivos de documentación XML no son necesarios para que IntelliSense funcione para el código dentro de un proyecto o de los proyectos a los que el proyecto hace referencia.

A menos que compile con -target:module, el archivo XML contiene las etiquetas <assembly></assembly>. Estas etiquetas especifican el nombre del archivo que contiene el manifiesto del ensamblado para el archivo de salida de la compilación.

Vea Etiquetas XML para comentarios para conocer las maneras de generar documentación a partir de comentarios en el código.

Para definir -doc en el entorno de desarrollo integrado de Visual Studio
1. Seleccione un proyecto en el Explorador de soluciones. En el menú Proyecto , haga clic en Propiedades.
2. Haga clic en la pestaña Compilar.
3. Establezca el valor en el cuadro Generar archivo de documentación XML.

Ejemplo

Vea Documentar el código con XML (Visual Basic) para obtener un ejemplo.

Vea también