Question

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

Answer 1

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

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

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

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

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

注意：我在问题发布后很长一段时间，因为SynProject目前还不存在，值得一看。这个帖子has been defined as a reference for that question。

Answer 2

Delphi + JavaDoc = DelphiCodeToDoc

Answer 3

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

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

Answer 4

尝试： - Doxygen文档 - Pas2Dox

Answer 5

自Delphi 2005以来，它是在Delphi编译器中构建的。它使用XMLDoc标准，该标准使用XML样式注释。就像C＃一样，所以我猜Sandcastle可以处理它。请参阅http://dn.codegear.com/article/32770和http://tondrej.blogspot.com/2006/03/xml-documentation-in-delphi-2006.html

另见Documenting Delphi

Answer 6

Sandcastle需要访问程序集才能生成它的文档，这意味着它只适用于.net语言（虽然我不确定Delphi.Net）。但是，Delphi 2007和2009有一个与C＃非常相似的内联XML文档。当您在项目选项中打开“生成XML文档”选项时，它将根据这些注释构建XML文档。然后可以使用XSLT生成所需的任何文档格式（这很难）。

Answer 7

DelphiCodeToDoc也有一个命令行，可以将它与持续集成工具一起使用（例如）。

Answer 8

这个问题很老了，但今天我遇到了同样的问题，发现了这篇文章。 Delphi 2007允许使用以下语法，这似乎与C＃文档相同：

/// <summary>
/// Summary of the function / class
/// </summary>
/// <param name="param1">Description of the parameter param1</param>
/// <param name="param2">Description of the parameter param2</param>
/// <param name="param3">Description of the parameter param3</param>
/// <returns>Description of the return value</returns>
function test(param1, param2, param3: string): string;

对于<summary>，似乎没有可能允许换行。 <br />不起作用。

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

8 个答案: