Agregar a la documentación básica de Visual NET ( VB.NET ) del proyecto es importante para que las personas que utilizan su programa tienen un lugar para encontrar más información acerca de las características que están teniendo problemas con el. . Visual Studio utiliza '' ' para indicar una línea de documentación, que se crea automáticamente una plantilla XML para . Al compilar el proyecto , Visual Studio creará un archivo XML de todos sus comentarios de la documentación . Cosas que necesitará
Microsoft Visual Studio 2005 , 2008 o 2010
Mostrar más instrucciones
1
Abra el proyecto VB.NET en Microsoft Visual Studio 2005 , 2008 o 2010 .
2
Busque el código de un tipo o miembro que desee documentar y coloque el cursor en la línea anterior del código. Un tipo incluye cosas tales como una interfaz o clase. Los miembros incluyen cosas tales como una subrutina , función, evento o propiedad.
3
Añada '' ' ( 3 caracteres simples comillas) al principio de la línea . Especifica una línea de documentación. El Editor de código se agregará un esqueleto XML correspondiente a los elementos de la línea por debajo de ella .
4
Añada su documentación en forma de texto entre las etiquetas XML. Es posible añadir nuevos documentación XML etiquetas de comentario editando el archivo " VBXMLDOC.xml " con un editor de texto. El archivo se encuentra en el apartado " Datos de programa " de Visual Studio o la carpeta " AppData " .
5
Agregar las líneas adicionales de código con los comentarios de documentación XML que utilizan el tipo o miembro. Una etiqueta mostrará información adicional sobre el tipo o miembro .
6 clic su proyecto en el Explorador de soluciones. Haga clic en el menú "Proyecto " y haga clic en " Propiedades". Haga clic en la ficha " Compilar" y añade " /doc " en el recuadro " Generar documentación XML file". Esto le dice al compilador para crear un archivo XML al compilar el proyecto.
7
Crear un archivo de documentación XML mediante la compilación de su proyecto VB.NET . El archivo aparecerá en la misma carpeta que el archivo. Exe o un archivo. Dll
.