He heredado más de 600 archivos de código fuente de ColdFusion que ejecutan un sitio web interno para mi empresa. Una de mis tareas es "documentarlo". La base del código representa aproximadamente 5 años de desarrollo y no hay especificaciones técnicas de lo que hace.Documentación automática del código de ColdFusion
Los desarrolladores han mantenido un registro de cambios de cada archivo y hay un encabezado consistente.
Mi idea es que puedo construir un mapa de dependencia de los diversos módulos y los procedimientos almacenados a los que se hace referencia para facilitar esta documentación escaneando los archivos de origen. He utilizado Doxygen en el pasado para el código fuente de C++ y me pregunto si existe una herramienta como esta para ColdFusion.
Una salida que estoy investigando es la capacidad de crear un archivo xmind como medio para visualizar las dependencias cruzadas en las interrelaciones de los módulos.
Gracias de antemano,
Chris
"Los desarrolladores han mantenido un registro de cambios de cada archivo y su encabezado es coherente". - ¡Esto no prueba nada más que las * intenciones declaradas * del desarrollador! (Y eso es suponiendo que siempre recordaron registrar cambios, etc.) –
5 años de edad. 600 archivos. ¿Cuáles son las posibilidades de que este sea un buen código OO, todo en cfc's, que tenga sugerencias (metadatos), que puedan usarse para generar una buena documentación? Probablemente muy poco. – Mark