8

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

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

我想了解的是是否有像 Delphi 和/或 FreePascal 这样的标准。

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

4

6 回答 6

15

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/

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

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

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

于 2009-04-15T09:49:34.557 回答
7

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

我正在将此模板用于方法文档：

///<summary></summary>
///<param name=''></param>
///<returns></returns>
///<exception cref=""></exception>
///<since>2009-04-15</since>
于 2009-04-15T08:53:18.607 回答
1

看起来 doxygen 有一个工具，可以结合使用来记录 Pascal 和 Delphi 代码。也许这会对你有所帮助。

于 2009-04-15T08:49:45.527 回答
1

在我目前正在进行的一个项目中，我们正在使用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;
于 2009-04-15T09:18:43.053 回答
1

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

于 2009-04-26T17:14:27.343 回答
0

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

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

于 2009-04-15T14:18:30.370 回答