Documentación del código de Visual Basic 6.0

Question

Me acaban de pedir que documente 10 años de desarrollo de VB6 realizado por una persona. Ha pasado un tiempo desde que miré el código VB6, así que básicamente me pregunto si alguien tiene algún consejo sobre cómo hacerlo mejor.

¿Hay algún buen software, gratis o no, que haría algo similar a javadoc para VB6, que podría ser útil?

O simplemente si alguien tiene alguna sugerencia para herramientas/métodos sobre cómo hacer esto. Cualquier consejo sería muy apreciado.

Answer 1

Puede encontrar mi complemento, Atomineer Pro Documentation útil. Puede generar y actualizar comentarios de JavaDoc, Qt, Doxygen y Xml-Documentation en código fuente (Visual Basic, C#, C++/CLI, C++, C, Java, unrealscript), y usted tiene mucho control sobre el formato que produce.

(edit: tenga en cuenta que este complemento solo funciona en versiones de Visual Studio desde 2005, por lo que no puede usarlo en VB6, solo para documentar código VB6 antiguo con una versión más reciente de Visual Studio. Una vez documentado, todavía se puede volver a cargar y compilar en VB6)

(Se podría decir que genera la documentación "repetitiva", pero genera mucho más que un simple esqueleto repetitivo - rellena tantos detalles como es posible minimizar la cantidad de documentación adicional que necesita para escribir)

Por lo tanto, no crea documentación externa de los comentarios (como JavaDoc), crea los comentarios ellos mismos, por lo que aún necesitaría otra herramienta para generar la documentación externa. Sin embargo, AtomineerUtils ahorraría mucho tiempo si tiene que generar nuevos comentarios de documentación para el código existente (no documentado), o si ya tiene el código comentado/documentado en un estilo Javadoc, AtomineerUtils puede procesar los comentarios de la documentación para convertirlos a Doxygen. o formatos de documentación XML, que pueden ayudarle a obtener compatibilidad con otras herramientas (Sandcastle, etc.) que pueden generar documentación externa para usted.

Para generar la documentación externa a partir de los comentarios del código fuente, Doxygen es una herramienta líder (y gratuita) de generación de documentación externa que puede compilar documentación de JavaDoc, Qt, Doxygen o documentación de formato Dcoumentation-XML. vale la pena probarlo

Answer 2

Solía ​​codificar en VB6 hace mucho tiempo, y nunca encontré ninguna herramienta decente que ayudara con la documentación en el sentido de Javadoc.

Me acercaría a esto desde el ángulo de lo que debe documentarse: ¿es para los desarrolladores entender la API o es para que un usuario trabaje con la aplicación? Asumiendo lo primero, entonces, ¿cuál es el mínimo indispensable con el que puede salirse con la suya de manera que un desarrollador pueda seguir lo que está sucediendo? Es posible que evite documentar todos los métodos y solo proporcione un enfoque general basado en casos de uso de movimientos de mano que podría estar separado del código por completo y basarse en sus exploraciones. Unos pocos diagramas buenos son un largo camino para transferir la comprensión.

Si es para que el usuario trabaje la aplicación, entonces está en los reinos del compilador de ayuda. Puede tener suerte y encontrar uno de este lote todavía está disponible: http://help-compiler.qarchive.org/

Alternativamente, si debe ser equivalente a Javadocs o no le pagan, entonces es posible que desee considerar escribir una herramienta para escanear sobre el código fuente y hacer una gran parte del relleno de parámetros estándar para usted. Una herramienta como Unix AWK realmente puede ayudar aquí.

Answer 3

Nuestra VBdocman hace exactamente lo que necesita. Utiliza los comentarios de javadoc y puede generar varios formatos de salida.

Answer 4

Puede probar VBDox, que es un generador de documentación de código fuente VB6 gratuito.