Delphi和/或FreePascal代码最常见的docblock

Question

我对PHP dockblocks非常熟悉，因为它是我过去15年以来的工作。

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

我想要了解的是，对于Delphi和/或FreePascal，是否存在类似的标准。

从我对很多代码的分析我从未见过，但我可能是错的。

Answer 1

Delphi documentation tools

使用适用于API文档的XMLDoc工具和使用Delphi 2005 http://edn.embarcadero.com/article/32770的HelpInsight

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/

Pascal浏览器http://www.peganza.com/

Doxygen 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

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

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

Answer 2

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

我正在使用此模板进行方法文档：

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

Answer 3

我更喜欢源外的文档（它总是很乱），并使用FPC附带的优秀fpdoc。 （FPC自己的文档都写在其中）。

Answer 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;

Answer 5

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

Answer 6

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

或者，有gabr指出的XMLDoc，还有很多其他工具，大多数具有相似的语法和细微差别。