ColdFusion代码的自动文档[关闭]答案

【问题标题】：Automatic Documentation of ColdFusion code [closed]ColdFusion代码的自动文档[关闭]
【发布时间】：2009-03-26 22:29:06
【问题描述】：

我继承了 600 多个 ColdFusion 源代码文件，为我的公司运行一个内部网站。我的任务之一是“记录”它。代码库代表了大约 5 年的开发，没有关于它的功能的技术规范。

开发者维护了每个文件的变更日志，并且有一致的header。

我的想法是，我可以构建各种模块和引用的存储过程的依赖关系图，以通过扫描源文件来简化此文档。我过去曾将 Doxygen 用于 C++ 源代码，我想知道 ColdFusion 是否存在这样的工具。

我正在研究的一个输出是创建 xmind 文件的能力，作为可视化模块相互关系中的交叉依赖关系的手段。

提前致谢，

克里斯

【问题讨论】：

"开发人员维护了每个文件的更改日志，并且它们是一致的标题。" -- 这仅证明了开发人员的陈述意图！（这是假设他们总是记得记录更改等）
5 岁。 600 个文件。这是好的 OO 代码，全部在 cfc 中，有提示（元数据），可用于生成好的文档的可能性有多大？可能很少。

标签： documentation coldfusion automation mindmapping

【解决方案1】：

ColdFusion 服务器有built in introspection，它为任何CFC 类输出类似javadoc 的文档。

见：http://YourColdfusionServer/CFIDE/componentutils/componentdoc.cfm

但是，它需要您的服务器的 RDS 登录名/密码。为了交付给第三方，我设置了一个递归脚本，它针对每个 cfc 文件的文档执行 cfhttp 提取，然后使用 cfdocument 将页面编译为 PDF。

【讨论】：

很棒的信息。非常感谢您回答这个问题，它为我在从 ColdFusion 迁移过程中节省了几天的精力。

【解决方案2】：

你可以从ColdDoc开始

另外，这是一个UML 2 CFC 生成器。

我猜你真正需要的是将coldfusion代码逆向工程为uml类图。我什么都不知道。

MagicDraw、Objecteering 似乎还没有这样做。

【讨论】：

【解决方案3】：

在自己尝试找到这个问题的答案后，我最终编写了这个解决方案：

ColdDuck

也许现在对你来说为时已晚，但我只是在宣传。

穆雷

【讨论】：

这是伟大的工作！我要试试这个，看看我能做些什么。谢谢！
您很可能是地球上唯一使用它的人！从那以后我也没有看过它！ ;-) 所以，我希望它对你有用。

【解决方案4】：

在我看来，创建自己的 Xmind 或 XMI 文件是可行的方法。 XMI 文件可能在工具之间更具可移植性，但我上次研究时，XMI 文件格式对于我可用于解决方案的时间来说有点令人生畏。如果标题的格式一致，足以使用 ReFind 或 Find 读取，我将构建一个使用 cfdirectory 和 cffile 遍历代码树并输出文件的脚本。

【讨论】：