【问题标题】：Most common docblock for Delphi and/or FreePascal codeDelphi 和/或 FreePascal 代码最常见的文档块
【发布时间】：2010-10-19 13:05:39
【问题描述】：

我对 PHP 停靠块非常熟悉，因为过去 15 年多以来我一直从事这项工作。

/**
  * Description
  *
  * @tag bla bla
  * @tag more bla bla
  */

我想了解的是是否有类似 Delphi 和/或 FreePascal 的标准。

根据我对大量代码的分析，我从未见过任何代码，但我可能大错特错。

【问题讨论】：

标签： delphi comments freepascal code-documentation docblocks

【解决方案1】：

Delphi 文档工具

在 Delphi 2005 中使用 XMLDoc 工具获取 API 文档和 HelpInsight http://edn.embarcadero.com/article/32770

Delphi 2006 中的 XML 文档 http://tondrej.blogspot.com/2006/03/xml-documentation-in-delphi-2006.html

DelphiCodeToDoc http://dephicodetodoc.sourceforge.net/

Doc-O-Matic http://www.doc-o-matic.com/examplesourcecode.html

PasDoc http://pasdoc.sipsolutions.net/

帕斯卡浏览器 http://www.peganza.com/

氧气 http://www.doxygen.nl/

Pas2Dox http://sourceforge.net/projects/pas2dox/

JADD - 只是另一个 DelphiDoc http://delphidoc.sourceforge.net/

Stackoverflow 讨论

是否有支持当前 Delphi 语法的 Delphi 代码文档？ https://stackoverflow.com/questions/673248/is-there-a-delphi-code-documentor-that-supports-current-delphi-syntax

delphi 的代码文档，类似于 javadoc 或 c# xml doc Code documentation for delphi similar to javadoc or c# xml doc

记录德尔福 https://stackoverflow.com/questions/33336/documenting-delphi

【讨论】：

【解决方案2】：

最新的 Delphis 支持解析 XML 文档。他们还在提示中使用此信息（例如，如果您将鼠标光标移到方法名称上）。

我正在使用这个模板来编写方法文档：

///<summary></summary>
///<param name=''></param>
///<returns></returns>
///<exception cref=""></exception>
///<since>2009-04-15</since>

【讨论】：

@gabr：您能否提供完整语法的链接？
@gabr：您至少可以使用您自己的记忆神经元映射吗？ ;)
我只在单元标题中使用了上面提到的标签加上和。

【解决方案3】：

我更喜欢源代码之外的文档（它总是变得凌乱），并使用 FPC 附带的优秀 fpdoc。（FPC自己的文档都写在里面）。

【讨论】：

【解决方案4】：

在我目前正在进行的一个项目中，我们使用的是DelphiCodeToDoc，它运行良好。它的语法如下所示：

type
  {* This is an example class }
  TMyClass = class
  private
  protected
  public
    {* Does some twiddling with AParam, and returns the result as String
       @param AParam Input value
       @return AParam incremented by 2, as String
       @throws Exception 'Boo' if it's full moon }
    function MyFunction(AParam: Integer): String;
  end;

【讨论】：

我知道这只是一个例子，我在吹毛求疵，但程序不返回值对吗？ ;)
大声笑：D 是的，你当然是完全正确的。更正了我的答案。

【解决方案5】：

It looks like doxygen has a tool 可以与document Pascal and Delphi code 结合使用。也许这会对你有所帮助。

【讨论】：

+1 我在我所有的商业 Delphi / Free Pascal 库中使用 doxygen 和 pas2dox，以 JavaDoc 风格进行评论就像一个魅力

【解决方案6】：

有多种标准，通常取决于所使用的文档工具。我们使用 PasDoc，因此我们主要遵循基于 JavaDoc 的格式 http://pasdoc.sipsolutions.net/。

另外，正如 gabr 所指出的，还有 XMLDoc，还有很多其他工具，大多数具有相似的语法，但有细微的差别。

【讨论】：