Delphi 和/或 FreePascal 代码最常见的文档块

发布于 2024-07-17 06:39:26 字数 239 浏览 11 评论 0原文

我对 PHP Dockblocks 非常熟悉，因为这是我过去 15 年多来的工作。

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

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

从我对大量代码的分析来看，我从未见过任何代码，但我可能是完全错误的。

原文

I'm quite familiar with PHP dockblocks since it's been my job for the last 15+ years.

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

What I'm trying to understand is if there is a standard like that for Delphi and/or FreePascal.

From my analysis on an awful lot of code I never seen any, but I could be dead wrong.

分享到QQ

分享到微博

如果你对这篇内容有疑问，欢迎到本站社区发帖提问参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。

发布评论

需要登录才能够评论，你可以免费注册一个本站的账号。

饮惑 2024-07-24 06:39:26

Delphi 文档工具

在 Delphi 2005 中使用 API 文档的 XMLDoc 工具和 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 - 只是另一个 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

记录 Delphi
https://stackoverflow.com/questions/33336/documenting-delphi

回复收藏 0 原文

并安 2024-07-24 06:39:26

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

我使用此模板作为方法文档：

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

Latest Delphis support parsing of XML documentation. They also use this information in hints (for example if you move the mouse cursor over a method name).

I'm using this template for method documentation:

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

回复收藏 0 原文

在风中等你 2024-07-24 06:39:26

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

回复收藏 0 原文

丘比特射中我 2024-07-24 06:39:26

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

On a project I'm currently working on, we're using DelphiCodeToDoc, which works reasonably well. Its syntax looks like this:

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;

回复收藏 0 原文