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

Question

已结束。此问题正在寻求书籍、工具、软件库等的推荐。它不满足 Stack Overflow guidelines 。目前不接受答案。

---

我们不允许提出寻求书籍、工具、软件库等推荐的问题。您可以编辑问题，以便用事实和引文来回答。

已关闭 3 年前。

Improve this question

我需要一个类似于 delphi 代码的 javadoc 或 c# xml doc 的代码文档工具。最好的工具是什么？我更喜欢一种技术，它将来可以兼容微软 SandcaSTLe 项目。

Answer 1

看看SynProject ，一个用 Delphi 编写的开源工具。

它旨在处理完整的文档工作流程，从规范到发行说明，包括测试、架构和设计；当然，还有一个集成的 Delphi 解析器，可以从现有的 Delphi 源代码生成体系结构文档。

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

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

例如，我目前使用它为一个巨大且旧的 Delphi 应用程序(大约 2,000,000 行用 Delphi 5 和 6 编写的代码)编写维护文档，之前没有可用的文档。您描述对代码所做的更改(通过引用单元/类/方法)，然后该工具将更新所有文档以反射(reflect)和跟踪这些修改。 SynProject 的设计符合一些非常“微妙”的监管规则 (IEC 62304)，但由于其独特的“扁平”设计，可用于任何项目。

注意:我在问题提出很久之后才发布这个问题，因为当时 SynProject 还不存在，并且值得一看。此线程has been defined as a reference for that question .