Cómo crear Vb.Net Documentación

Adición de la documentación a tu Basic. NET Visual (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. Visual Studio utiliza'' 'para significar una documentación de la línea, 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. 

CREAR VB.NET

Lo que necesita

Microsoft Visual Studio 2005, 2008 o 2010

Abra el proyecto de VB.NET en Microsoft Visual Studio 2005, 2008 o 2010.

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.

Agregar'' '(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.

Agregue 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".

Agregue las líneas adicionales de código con los comentarios de documentación XML que utilizan el tipo o miembro. Una etiqueta de resumen mostrará información adicional sobre el tipo o miembro.

Haga clic en el 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.

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.

Consejos y advertencias

Descarga un compilador de documentación, como Castillo de arena para procesar el archivo XML y proporcionar documentación adicional de los comentarios.