-Doc

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

Sintaxis

-doc[+ | -]  

o

-doc:file  

Argumentos

Término	Definición
+ | -	Opcional. Especificar +, o simplemente -doc, hace que el compilador genere información de documentación y colóquela en un archivo XML. Especificar - es el equivalente de no especificar -doc, lo que provoca que no se cree información de documentación.
file	Obligatorio si -doc: se usa. 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, rodea el nombre con comillas (" ").

Observaciones

La -doc opción controla si el compilador genera un archivo XML que contiene los comentarios de documentación. Si usa la -doc:file sintaxis, el file parámetro especifica el nombre del archivo XML. Si usa -doc o -doc+, el compilador toma el nombre de archivo XML del archivo ejecutable o la biblioteca que está creando el compilador. Si usa -doc- o no especifica la -doc opción , 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:

• Tipos definidos por el usuario, como una clase o interfaz

• Miembros, como un campo, evento, propiedad, función o subrutina.

Para usar el archivo XML generado con la característica IntelliSense de Visual Studio, deje que el nombre de archivo del archivo XML sea el mismo que el ensamblado que desea admitir. Asegúrese de que el archivo XML está en el mismo directorio que el ensamblado para que, cuando se haga referencia al ensamblado en el proyecto de Visual Studio, también se encuentra 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 dentro de los proyectos a los que hace referencia un proyecto.

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 de ensamblado para el archivo de salida de la compilación.

Consulte Etiquetas de comentario XML para obtener formas de generar documentación a partir de comentarios en el código.

Para establecer -doc en el entorno de desarrollo integrado de Visual Studio
1. Tener un proyecto seleccionado 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

Consulte Documenting Your Code with XML (Documentar el código con XML ) para obtener un ejemplo.

Consulte también

• Compilador de Visual Basic Command-Line
• Documentar el código con XML