/doc

Artículo
10/07/2008

Actualización: noviembre 2007

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

/doc[+ | -]
' -or-
/doc:file

Argumentos

+ | -
Opcional. Si se especifica +, o simplemente /doc, el compilador genera información de documentación y la incluye en un archivo XML. Especificar - equivale a no especificar /doc, lo que hace que no se cree ninguna información de documentación.
file
Obligatorio si se utiliza /doc:. Especifica el archivo de resultados de XML, que se llena con los comentarios de los archivos del código fuente de la compilación. Si el nombre de archivo contiene un espacio, incluya el nombre entre comillas (" ").

Comentarios

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

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

Tipos definidos por el usuario, como una clase o interfaz
Miembros, como un campo, evento, propiedad, función o subrutina.

Para utilizar el archivo XML generado con la función IntelliSense de Visual Studio, el nombre de archivo XML debe ser el mismo que el ensamblado que desea compatibilizar. Asegúrese de que el archivo XML esté en el mismo directorio que el ensamblado de modo que cuando se haga referencia a éste último en el proyecto de Visual Studio, se encuentre también el archivo .xml. Los archivos de documentación XML no son necesarios para que IntelliSense funcione para un código dentro de un proyecto o dentro de proyectos a los que hace referencia un proyecto.

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

Vea Etiquetas XML recomendadas para comentarios de documentación (Visual Basic) para conocer modos de generar documentación a partir de los comentarios del código.

Para establecer /doc en el entorno de desarrollo integrado de Visual Studio

Tenga seleccionado un proyecto en el Explorador de soluciones. En el menú Proyecto, haga clic en Propiedades. Para obtener más información, vea Introducción al Diseñador de proyectos.
Haga clic en la ficha Compilar.
Establezca el valor en el cuadro Generar archivo de documentación XML.