8

過去 15 年以上にわたって PHP ドックブロックに携わってきたので、PHP ドックブロックについてはよく知っています。

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

私が理解しようとしているのは、Delphi や FreePascal にそのような標準があるかどうかです。

非常に多くのコードを分析した結果、見たことはありませんが、完全に間違っている可能性があります。

4

6 に答える 6

15

Delphiドキュメントツール

APIドキュメント用のXMLDocツールとDelphi2005でのHelpInsightの使用   http://edn.embarcadero.com/article/32770

Delphi2006の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-ちょうど別の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＃xmldocに類似した   delphiのコードドキュメントjavadocまたはc＃xmldocに類似したdelphiのコードドキュメント

Delphiのドキュメント   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

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;
于 2009-04-15T09:18:43.053 に答える
1

私はソースの外側にあるドキュメントを好み (常に乱雑になります)、FPC に付属している優れた fpdoc を使用します。（FPC独自のドキュメントが書かれています）。

于 2009-04-26T17:14:27.343 に答える
1

doxygen には、Pascal と Delphi のコードを文書化するために併用できるツールがあるようです。多分それはあなたを助けるでしょう。

于 2009-04-15T08:49:45.527 に答える