Documentación del código con XML (Visual Basic)

  • Artículo

En Visual Basic, puede documentar el código mediante XML.

Comentarios de la documentación XML

Visual Basic proporciona una manera sencilla de crear automáticamente documentación XML para proyectos. Puede generar automáticamente un esqueleto XML para los tipos y miembros y, a continuación, proporcionar resúmenes, documentación descriptiva para cada parámetro y otros comentarios. Con la configuración adecuada, la documentación XML se emite automáticamente en un archivo XML con el mismo nombre de archivo raíz que el proyecto. Para obtener información sobre cómo configurar la generación del archivo de documentación XML, vea la opción del compilador -doc y la propiedad GenerateDocumentationFile MSBuild.

El archivo XML se puede consumir o manipular de otro modo como XML. Este archivo se encuentra en el mismo directorio que el .exe de salida o .dll archivo del proyecto.

La documentación XML empieza con '''. El procesamiento de estos comentarios tiene algunas restricciones:

  • La documentación debe ser XML con formato correcto. Si el XML no tiene el formato correcto, se generará una advertencia y el archivo de documentación incluirá un comentario en el que se indica que se detectó un error.

  • Los desarrolladores pueden crear su propio conjunto de etiquetas, Hay un conjunto recomendado de etiquetas (consulte Etiquetas de comentario XML). Algunas de las etiquetas recomendadas tienen significados especiales:

    • La etiqueta <param> se usa para describir parámetros. Si se usa, el compilador comprobará que el parámetro existe y que todos los parámetros se describen en la documentación. Si se produce un error en la comprobación, el compilador emite una advertencia.

    • El atributo cref se puede asociar a cualquier etiqueta para proporcionar una referencia a un elemento de código. El compilador comprueba si existe este elemento de código. Si se produce un error en la comprobación, el compilador emite una advertencia. El compilador también respeta todas las instrucciones Imports cuando busca un tipo descrito en el atributo cref.

    • IntelliSense usa la etiqueta <summary> en Visual Studio para mostrar información adicional sobre un tipo o miembro.

Para obtener más información sobre cómo crear un archivo XML con los comentarios de documentación, vea los temas siguientes:

Vea también