类似于javadoc或c#xml doc的delphi代码文档

Question

我需要一个类似于javadoc的代码文档工具或者用于delphi代码的c#xml doc.什么是最好的工具？我更喜欢一种技术,它在未来与微软沙堡项目兼容.

Answer 1

看一下用Delphi编写的开源工具SynProject.

它旨在处理完整的文档工作流程,从规范到发布说明,包括测试,架构和设计; 当然还有一个集成的Delphi解析器,用于从现有的Delphi源代码生成架构文档.

对于体系结构文档,源代码可以提取注释(ala PasDoc),然后将此文本嵌入到主体系结构文档中(具有类层次结构图和单元依赖性).

您在专用文本编辑器中使用类似wiki的语法编写纯文本文件,然后SynProject从中创建格式良好的Word文档.某些向导可用于访问内容.但由于它存储为普通文件,因此多个程序员可以使用任何SCM工具(SVN,Fossil ......)在其上书写.

例如,我目前使用它来编写大型和旧的Delphi应用程序的维护文档(大约2,000,000行使用Delphi 5和6编写的代码),没有先前可用的文档.您描述了对代码所做的更改(通过引用单元/类/方法),然后该工具将更新所有文档以反映和跟踪这些修改.SynProject的设计符合一些非常"精密"的规则(IEC 62304),但由于其独特的"扁平"设计,可用于任何项目.

注意:我在问题发布后很长一段时间,因为SynProject目前还不存在,值得一看.该线程已被定义为该问题的参考.

Answer 2

Delphi + JavaDoc = DelphiCodeToDoc

Answer 3

据我所知,没有任何工具可以轻松地与Microsoft Sandcastle兼容 - 至少在有人真的很难写一个,修改现有的工具或创建工具链来正确转换输出之前.

我个人使用PasDoc取得了巨大的成功.我建议构建最新的SVN版本,因为当前版本偶尔会出现复杂的界面定义.

Answer 4

尝试: - Doxygen文档 - Pas2Dox