Compartir vía

Documentar el código con XML (Visual Basic)

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 sus 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, consulte 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 archivo de salida .exe o .dll del proyecto.

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

  • La documentación debe tener un formato XML correcto. Si el XML no tiene un formato correcto, se genera una advertencia y el archivo de documentación contiene un comentario que indica que se encontró 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 que este elemento de código existe. Si se produce un error en la comprobación, el compilador emite una advertencia. El compilador también respeta las Imports declaraciones al buscar un tipo descrito en el atributo cref.

    • IntelliSense usa la <etiqueta de resumen> 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 comentarios de documentación, consulte los temas siguientes:

Consulte también