Documentazione automatica del codice ColdFusion

Ho ereditato oltre 600 file di codice sorgente ColdFusion eseguendo un sito Web interno per la mia azienda. Uno dei miei compiti è "documentarlo". Il codice base rappresenta circa 5 anni di sviluppo e non ci sono specifiche tecniche su ciò che fa.Documentazione automatica del codice ColdFusion

Gli sviluppatori hanno mantenuto un registro delle modifiche di ogni file e c'è un'intestazione coerente.

Il mio pensiero è che posso creare una mappa delle dipendenze dei vari moduli e procedure memorizzate di riferimento per facilitare questa documentazione scansionando i file sorgente. Ho usato Doxygen in passato per il codice sorgente C++ e mi chiedo se esiste uno strumento come questo per ColdFusion.

Un output che sto studiando è la possibilità di creare un file xmind come mezzo per visualizzare le dipendenze incrociate nelle inter-relazioni tra moduli.

Grazie in anticipo,

Chris

fonte

2009-03-26 Anonymous

"Gli sviluppatori hanno mantenuto un registro delle modifiche di ogni file e la loro è un'intestazione coerente." - Questo non prova altro che le * intenzioni dichiarate * dello sviluppatore! (E supponiamo che si siano sempre ricordati di registrare le modifiche, ecc.) –

5 anni. 600 file. Quali sono le possibilità che questo sia un buon codice OO, tutti in cfc, che hanno suggerimenti (metadati), che possono essere usati per generare una buona documentazione? Probabilmente molto poco. – Mark

si potrebbe iniziare con ColdDoc

Inoltre, ecco un generatore UML 2 CFC.

Immagino che quello di cui hai veramente bisogno sia qualcosa per decodificare il codice coldfusion in diagrammi di classe uml. Non so nulla di ciò che è in cima alla mia testa.

MagicDraw, Objecteering non sembrano ancora farlo.

fonte

2009-03-26 22:34:06

Mi sembra che creare il proprio file Xmind o XMI sia la strada da percorrere. Il file XMI può essere più portabile tra gli strumenti, ma l'ultima volta che ho visto che i formati di file XMI erano un po 'scoraggianti per il tempo che avevo a disposizione per lavorare sulla soluzione. Se la formattazione delle intestazioni coerente è sufficiente per leggere con ReFind o Trova, creerei uno script che utilizzi cfdirectory e cffile per percorrere la struttura del codice e generare i file.

fonte

2009-03-30 20:53:14 hofo

Il server ColdFusion ha built in introspection che emette la documentazione simile a javadoc per qualsiasi classe CFC.

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

Tuttavia, si richiede una RDS login/password per il server. Per la consegna a terze parti, ho impostato uno script ricorsivo che esegue un recupero cfhttp sui documenti per ogni file cfc e quindi compila le pagine in PDF con cfdocument.

fonte

2011-02-07 19:41:05

Favolosa informazione.Apprezzo molto che tu abbia risposto a questo, mi ha risparmiato giorni di sforzi durante una migrazione lontano da ColdFusion. –

Dopo aver tentato di trovare una risposta a questa domanda che mi sono finito per scrivere questa soluzione:

ColdDuck

Forse è troppo tardi per voi ora, ma io sono solo diffondendo la parola.

Murray

fonte

2013-06-29 21:29:41 Murrah

Questo è un ottimo lavoro! Ho intenzione di provare questo e vedere cosa posso farne. Grazie! –

Potresti essere l'unica altra persona sul pianeta che lo sta usando! E non l'ho nemmeno guardato da allora! ;-) Quindi, spero che funzioni per te. – Murrah

Documentazione automatica del codice ColdFusion

risposta

Problemi correlati