Documentación automática del código de ColdFusion

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

Fuente

2009-03-26 Anonymous

"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

usted podría comenzar con ColdDoc

Además, aquí hay un generador de UML 2 CFC.

Supongo que lo que realmente necesita es algo de ingeniería inversa del código de coldfusion en diagramas de clase uml. No sé nada de lo que tengo en la cabeza.

MagicDraw, Objecteering parece que no lo hacen todavía.

Fuente

2009-03-26 22:34:06

Me parece que crear tu propio archivo Xmind o XMI es el camino a seguir. El archivo XMI puede ser más portátil entre herramientas, pero la última vez que lo hice, los formatos de archivo XMI me intimidaron por el tiempo que tenía disponible para trabajar en la solución. Si el formato de los encabezados es consistente para leer con ReFind o Find, crearía un script que utiliza cfdirectory y cffile para recorrer el árbol de códigos y sacar los archivos.

Fuente

2009-03-30 20:53:14 hofo

El servidor ColdFusion tiene built in introspection que emite javadoc como documentación para cualquier clase de CFC.

Ver: http://YourColdfusionServer/CFIDE/componentutils/componentdoc.cfm

Sin embargo, se requiere una RDS de usuario/contraseña para su servidor. Para la entrega a terceros, configuro un script recursivo que hace una búsqueda de cfhttp contra los documentos para cada archivo cfc, y luego compila las páginas en PDF con cfdocument.

Fuente

2011-02-07 19:41:05

Información fabulosa.Realmente aprecio que respondas esto, me ha ahorrado días de esfuerzo durante una migración lejos de ColdFusion. –

Después de tratar de encontrar una respuesta a esta pregunta yo terminé escribiendo esta solución:

ColdDuck

Tal vez es demasiado tarde para que ahora, pero sólo estoy haciendo correr la voz.

Murray

Fuente

2013-06-29 21:29:41 Murrah

¡Este es un gran trabajo! Voy a probar esto y ver qué puedo hacer con él. ¡Gracias! –

¡Puede que seas la única persona en el planeta que lo está usando! ¡Y tampoco lo he visto desde entonces! ;-) Por lo tanto, espero que funcione para usted. – Murrah

Documentación automática del código de ColdFusion

Respuesta

Cuestiones relacionadas