Documentar el código con XML (Visual Basic)
Actualización: noviembre 2007
En Visual Basic, puede documentar el código utilizando XML
Comentarios sobre la documentación XML
Visual Basic proporciona un medio sencillo para crear automáticamente documentación XML para los proyectos. Puede generar automáticamente un esquema 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 apropiada, la documentación XML se emite automáticamente en un archivo XML que tiene el mismo nombre que el proyecto y la extensión .xml. Para obtener más información, vea /doc.
El archivo XML se puede utilizar o, de lo contrario, manipularse como XML. Este archivo se encuentra en el mismo directorio que el archivo .exe de salida o el archivo .dll del proyecto.
La documentación XML empieza con '''. El procesamiento de estos comentarios presenta algunas restricciones:
La documentación debe estar en XML bien formado. Si el código XML no está bien formado, se generará una advertencia y el archivo de documentación incluirá un comentario que mencione el error encontrado.
Los programadores pueden crear su propio conjunto de etiquetas. Existe un conjunto de etiquetas recomendado (vea "Secciones relacionadas" en este tema). Algunas de las etiquetas recomendadas tienen significados especiales:
La etiqueta <param> se usa para describir parámetros. Cuando se utiliza, el compilador comprueba si el parámetro existe y si todos los parámetros están descritos en la documentación. Si la comprobación no tiene éxito, 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 ese elemento de código. Si la comprobación no tiene éxito, el compilador emite una advertencia. El compilador también respeta cualquier instrucción Imports cuando busca un tipo descrito en el atributo cref.
La etiqueta <summary> la utiliza IntelliSense en Visual Studio para mostrar información adicional sobre un tipo o miembro.
Secciones relacionadas
Si desea obtener información sobre cómo crear un archivo XML con comentarios de documentación, vea los siguientes temas: