En uno de mis primeros acercamientos a Java descubrí Javadoc. Básicamente es un sistema que permite generar documentación HTML a partir de los comentarios que se van insertando en el código fuente. En Visual Basic 6, el lenguaje en el que más programo, no existe nada parecido, y generar la documentación del código fuente puede reaultar algo realmente terrible.
Sin embargo, he encontrado Vbdox, un programa Gnu realmente interesante que te permite precisamente eso: generar documentación HTML a partir de los comentarios que se insertan en el código vb. Lo único que hay que hacer es escribir un comentario en cada función (ésta es la único opción que utilizo) con el siguiente formato:
'============================================
' Name:
' Input:
' Output:
' Purpose:
' Remarks:
'============================================
En Name hay que poner el nombre de la función, procedimiento, etc. En Input las variables de entrada, en Output las de salida, en Purpose que es lo que hace la función y Remarks algún comentario (yo pongo la fecha y el autor de la función). Con esto, Vbdox generará la documentación en HTML de todo tu proyecto. Además, se pueden documentar los módulos, formularios, clases, etc. Lo mejor es bajarse el programa y probar el pequeño ejemplo que trae el programa. Y si estás acostumbrado a escribir los comentarios como java puedes utilizar el formato. Sencillamente genial.
Sin embargo, he encontrado Vbdox, un programa Gnu realmente interesante que te permite precisamente eso: generar documentación HTML a partir de los comentarios que se insertan en el código vb. Lo único que hay que hacer es escribir un comentario en cada función (ésta es la único opción que utilizo) con el siguiente formato:
'============================================
' Name:
' Input:
' Output:
' Purpose:
' Remarks:
'============================================
En Name hay que poner el nombre de la función, procedimiento, etc. En Input las variables de entrada, en Output las de salida, en Purpose que es lo que hace la función y Remarks algún comentario (yo pongo la fecha y el autor de la función). Con esto, Vbdox generará la documentación en HTML de todo tu proyecto. Además, se pueden documentar los módulos, formularios, clases, etc. Lo mejor es bajarse el programa y probar el pequeño ejemplo que trae el programa. Y si estás acostumbrado a escribir los comentarios como java puedes utilizar el formato. Sencillamente genial.
3 comentarios:
Pues yo se programar el video!
Bueno, y como no podia ser de otra manera, tambien esta la vercion para C/C++ que como son primos hermanos funciona exactamente igual de la misma manera. Por cierto, fue una de las herramientas que utilize en mi paso por las 'infiernos' de SantaLucia.
De todos los 'infiernos' siempre se puede sacar algo bueno, aunque es preferible que sacarlo de los 'paraisos'.
Publicar un comentario