Una de las cuestiones más importantes que todo desarrollador debe tener siempre en cuenta cuando hace un programa reside en la necesidad de comentar correctamente el código (aunque muchos no lo hagan). Un buen código comentado siempre te puede salvar de estar horas y horas intentando descifrar que hace (incluso si eres tu el autor del mismo), facilitando la corrección de errores. En Visual Basic .Net, al estilo de Javadoc, existe una manera de ir poniendo comentarios en las funciones con sintaxis xml. Pero en este caso, y dado que tengo mucho código heredado de la antigua versión 6 de Visual Basic, necesito que mi querido VbDox (del que ya se comentó algo en este mismo blog) siga funcionando perfectamente, y me genere los comentarios para la nueva plataforma de Microsoft.
Sin embargo no todo iba a ser tan fácil, y aunque en la documentación del programa aparece que se soportan los fichero sln y vbpproj del nuevo Visual Basic la realidad es bien distinta, y, como suele ocurrir casi siempre, no termina de funcionar correctamente. Pero antes de que nos tiremos de los pelos y nos toque rescribir los comentarios al nuevo estándar que propone .Net, podemos utilizar un simple truco que nos servirá para poder utilizar los comentarios de nuestro código con VbDox.
Los pasos a seguir para hacerle un pequeño apaño al vbdox para que genere la documentación para los proyectos de Visual Basic .Net 2005 son:
1) Generar un fichero que se llame nombre_proyecto.vbp con la siguiente estructura:
Module="nombre_modulo"; ruta_del_modulo
Module="nombre_modulo"; ruta_del_modulo
Es decir, tendremos una línea por cada fichero.vb que tengamos en nuestro proyecto (formularios, módulos, clases, etc.).
Por ejemplo: si nuestro programa se llama coches.sln tendremos que crear un fichero que se llame coches.vbp. Este fichero podría ser algo así:
Module="frmPrincipal"; c:\proyectos\coches\frmPrincipal.vb
Module="Funciones"; c:\proyectos\coches\Funciones.vb
Module="AccesoBd"; c:\proyectos\coches\AccesoBd.vb
2) Llamar al vbdox desde la linea de comandos indicándole dónde esta este fichero. Para el caso anterior sería:
vbdox -o c:\proyectos\coches\doc coches.vbp
3) Con esto tendréis la documentación generada al estilo que se conseguía con Visual Basic 6. En algunos momentos el Vbdox se lía y saca algo extraño pero funciona bastante bien. Espero que con esto evitéis tener que volver a rescribir todos los comentarios.
Enlaces relacionados:
- Vbdox para Visual Basic 6
- El proyecto VbDox en SourceForge
- El proyecto Ndoc para generar la nueva documentación de Visual Basic .Net.
- Ejemplo de documentación generada para Visual Basic .Net de Microsoft.
Sin embargo no todo iba a ser tan fácil, y aunque en la documentación del programa aparece que se soportan los fichero sln y vbpproj del nuevo Visual Basic la realidad es bien distinta, y, como suele ocurrir casi siempre, no termina de funcionar correctamente. Pero antes de que nos tiremos de los pelos y nos toque rescribir los comentarios al nuevo estándar que propone .Net, podemos utilizar un simple truco que nos servirá para poder utilizar los comentarios de nuestro código con VbDox.
Los pasos a seguir para hacerle un pequeño apaño al vbdox para que genere la documentación para los proyectos de Visual Basic .Net 2005 son:
1) Generar un fichero que se llame nombre_proyecto.vbp con la siguiente estructura:
Module="nombre_modulo"; ruta_del_modulo
Module="nombre_modulo"; ruta_del_modulo
Es decir, tendremos una línea por cada fichero.vb que tengamos en nuestro proyecto (formularios, módulos, clases, etc.).
Por ejemplo: si nuestro programa se llama coches.sln tendremos que crear un fichero que se llame coches.vbp. Este fichero podría ser algo así:
Module="frmPrincipal"; c:\proyectos\coches\frmPrincipal.vb
Module="Funciones"; c:\proyectos\coches\Funciones.vb
Module="AccesoBd"; c:\proyectos\coches\AccesoBd.vb
2) Llamar al vbdox desde la linea de comandos indicándole dónde esta este fichero. Para el caso anterior sería:
vbdox -o c:\proyectos\coches\doc coches.vbp
3) Con esto tendréis la documentación generada al estilo que se conseguía con Visual Basic 6. En algunos momentos el Vbdox se lía y saca algo extraño pero funciona bastante bien. Espero que con esto evitéis tener que volver a rescribir todos los comentarios.
Enlaces relacionados:
- Vbdox para Visual Basic 6
- El proyecto VbDox en SourceForge
- El proyecto Ndoc para generar la nueva documentación de Visual Basic .Net.
- Ejemplo de documentación generada para Visual Basic .Net de Microsoft.
No hay comentarios:
Publicar un comentario