ColdFusionコードの自動ドキュメント

私の会社の内部Webサイトを実行している600個以上のColdFusionソースコードを継承しました。私の仕事の1つは、それを「文書化」することです。コードベースは約5年間の開発を表しており、それが何をするのかの技術仕様はありません。ColdFusionコードの自動ドキュメント

開発者は各ファイルの変更ログを保持しており、一貫したヘッダーがあります。

私は、さまざまなモジュールと参照されたストアドプロシージャの依存関係マップを作成して、ソースファイルをスキャンすることによってこのドキュメントを容易にすることができると考えました。以前C++ソースコードとしてDoxygenを使用していましたが、このようなツールがColdFusion用に存在するかどうかは疑問です。

私は、モジュールの相互関係の相互依存関係を視覚化する手段として、xmindファイルを作成する能力を調査しています。

事前のおかげで、

クリス

出典

2009-03-26 Anonymous

"開発者は各ファイルの変更履歴を保持しており、一貫したヘッダーです。" - これは開発者の*明示された意図*以外の何も証明しません！（それは彼らがいつもログの変更などを思い出すと仮定している） –

5歳。 600ファイル。これは、良い文書を生成するために使用できるヒント（メタデータ）を持つ、cfcのすべての、良いOOコードの可能性は何ですか？おそらくほとんどありません。 – Mark

あなたは、またColdDoc

と相続人UML 2 CFC発電を開始することができます。

あなたが本当に必要とするのは、coldfusionコードをumlクラス図にリバースエンジニアリングするものです。私は頭の上から何も知らない。

MagicDraw,Objecteeringまだしていないようです。

出典

2009-03-26 22:34:06

自分のXmindやXMIファイルを作成するのが好きです。 XMIファイルはツール間でより移植性が高いかもしれませんが、私が最後にXMIファイル形式を検討したときに、私が解決策に取り組んでいた時間のために少し難解でした。一貫性のあるヘッダーの書式設定がReFindまたはFindで読むには十分であれば、cfdirectoryとcffileを使用してコードツリーを歩み、ファイルを出力するスクリプトを作成します。

出典

2009-03-30 20:53:14 hofo

ColdFusionサーバーには、すべてのCFCクラスに関するjavadocのような出力を持つbuilt in introspectionがあります。

参照してください：http://YourColdfusionServer/CFIDE/componentutils/componentdoc.cfm

しかし、それはあなたのサーバー用のRDSのログイン/パスワードが必要です。サードパーティへの配信のために、私はcfhttpを各cfcファイルのドキュメントに対してフェッチした後、cfdocumentでPDFにページをコンパイルする再帰スクリプトを設定します。

出典

2011-02-07 19:41:05

素晴らしい情報です。これに答えることに本当に感謝しています。ColdFusionから移行する際の努力の節約になりました。 –

自分自身をこの質問への答えを見つけようとした後、私は、このソリューションを書き終わった：

ColdDuck

を多分それが今では遅すぎるあなたのためですが、私はただ言葉を広めています。

Murray

出典

2013-06-29 21:29:41 Murrah

これは素晴らしい作品です！私はこれを試して、私がそれを作ることができるものを見るつもりです。ありがとう！ –

それを使っている惑星の唯一の他人かもしれません！私はそれ以来それを見ていませんでした！ ;-)だから、私はそれがあなたのために働くことを願っています。 – Murrah

ColdFusionコードの自動ドキュメント

答えて

関連する問題