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

我非常熟悉PHP dockblocks，因为它是我过去15年多的工作

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

我想了解的是，对于Delphi和/或FreePascal是否有这样的标准

---

从我对大量代码的分析中，我从未见过任何代码，但我可能完全错了。

这可以与。也许这会对您有所帮助。

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

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

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

///
///
///
///
///2009-04-15

在我目前正在进行的一个项目中，我们正在使用它，它运行得相当好。其语法如下所示：

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;

Delphi文档工具 在Delphi2005中使用XMLDoc工具进行API文档和HelpInsight

delphi2006中的XML文档

DelphiCodeToDoc

Doc-O-Matic

帕斯多克

Pascal浏览器

强氧

Pas2Dox

JADD-只是另一个医生

堆栈溢出讨论 是否有支持当前Delphi语法的Delphi代码文档管理器？

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

记录德尔菲

---

有几种标准，通常取决于所使用的文档工具。我们使用PasDoc，所以我们主要遵循它基于JavaDoc的格式

---

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

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

+1我在我所有的商业Delphi/Free Pascal库中使用doxygen和pas2dox，用JavaDoc风格的注释就像charm@gabr：你能提供完整语法的链接吗？@gabr：你能至少使用你自己的内存映射吗？；）我只使用上面提到的加号和单位标题中的标记。我知道这只是一个示例，我只是吹毛求疵，但过程不会返回值，对吗？；）Lol:D是的，你当然完全正确。更正了我的答案。