最も一般的docblockのためのDelphiおよび/またはFreePascalコード

StackOverflow https://stackoverflow.com/questions/750810

質問

私は非常に馴染みのリリースでは以下のセキュリティdockblocksかして仕事における15。

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

私が理解しようとする場合は、標準のようなDelphiおよび/またはFreePascal.

からの分析は、どのコードを私は見たことのない他のものをとることができると思いますか死んで間違っています。

役に立ちましたか？

解決

Delphiドキュメントツール

APIドキュメントにXMLDOCツールを使用し、Delphi 2005でヘルプインサイトhttp://edn.embarcadero.com/article/32770

Delphi 2006のXMLドキュメントhttp://tondrej.blogspot.com/2006/03/xml-documentation-in-delphi-2006.html

Delphicodetodochttp://dephicodetodoc.sourceforge.net/

doc-o-matichttp://www.doc-o-matic.com/examplesourcecode.html

Pasdochttp://pasdoc.sipsolutions.net/

パスカルブラウザhttp://www.peganza.com/

ドキシゲンhttp://www.doxygen.nl/

PAS2DOXhttp://sourceforge.net/projects/pas2dox/

JADD-ちょうど別のDelphidochttp://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に類似したDelphiのコードドキュメントjavadocまたはc＃xml docに類似したDelphiのコードドキュメント

Delphiの文書化https://stackoverflow.com/questions/33336/documenting-delphi

他のヒント

XMLドキュメントの最新のDelphisサポートの解析。また、この情報をヒントで使用します（たとえば、メソッド名にマウスカーソルを移動する場合）。

メソッドドキュメントにこのテンプレートを使用しています。

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

というものはツール できると組み合わせて使用することを 文書Pascalとするmicrosoft社の最新製品もサポートコード.それがお手伝いいたします。

通常、使用されているドキュメントツールに応じて、いくつかの標準があります。私たちはpasdocを使用しているので、主にその形式を遵守します http://pasdoc.sipsolutions.net/ Javadocに基づいています。

あるいは、GABRが指摘したようにXMLDOCがあり、他にもかなりのツールがあり、ほとんどが微妙な違いを持つ同様の構文を持っています。

ライセンス： CC-BY-SA と 帰属
所属していません StackOverflow
scroll top