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/的
Pascal浏览器 http://www.peganza.com/的
Doxygen http://www.doxygen.nl/
Pas2Dox http://sourceforge.net/projects/pas2dox/
JADD - Just Another 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文档的 Delphi 代码文档 Code documentation for delphi similar to javadoc or c# xml doc
编写 Delphi 文档 https://stackoverflow.com/questions/33336/documenting-delphi

最新的Delphis支持XML文档的解析。他们也在提示中使用这些信息（例如，如果您将鼠标光标移动到方法名称上）。
我使用这个模板来编写方法文档：

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

字符串

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

在我目前正在做的一个项目中，我们使用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;

字符串

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

有几种标准，通常取决于所使用的文档工具。我们使用PasDoc，所以我们主要遵循其基于JavaDoc的格式http://pasdoc.sipsolutions.net/。
或者，正如gabr指出的那样，有XMLDoc，还有很多其他工具，大多数都有类似的语法，但有细微的差异。