ColdFusion代码的自动文档

Question

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

开发人员维护了每个文件的更改日志，并且标题是一致的。

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

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

提前致谢，

克里斯

Answer 1

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

请参阅：http://YourColdfusionServer/CFIDE/componentutils/componentdoc.cfm

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

Answer 2

您可以从ColdDoc

开始

此外，还有一个UML 2 CFC生成器。

我猜你真正需要的是将coldfusion代码反向工程为uml类图。我不知道我头脑中的任何东西。

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

Answer 3

在我试图找到这个问题的答案后，我最终写出了这个解决方案：

ColdDuck

现在可能现在为时已晚，但我只是传播这个词。

默里

Answer 4

听起来像创建自己的Xmind或XMI文件就好了。 XMI文件在工具之间可以更容易移植，但是上次我看到这样做时，XMI文件格式在我可以使用解决方案时有点令人生畏。如果标题的格式一致就足以用ReFind读取或者查找我将构建一个脚本，该脚本使用cfdirectory和cffile来遍历代码树并输出文件。