16

Delphi コード用の javadoc または c# xml doc に似たコード ドキュメント ツールが必要です。最適なツールは何ですか? 私は、Microsoft のサンドキャッスル プロジェクトと将来的に互換性のあるテクノロジを好みます。

4

8 に答える 8

7

Delphiで書かれたオープンソースツールであるSynProjectを見てください。

仕様からリリースノートまで、テスト、アーキテクチャ、設計を含む完全なドキュメントワークフローを処理するように設計されています。もちろん、既存のDelphiソースコードからアーキテクチャドキュメントを生成するための統合されたDelphiパーサーがあります。

アーキテクチャドキュメントの場合、ソースコードはコメント（ala PasDoc）を抽出し、このテキストをメインのアーキテクチャドキュメント（クラス階層図とユニットの依存関係を含む）に埋め込むことができます。

専用のテキストエディタでwikiのような構文を使用してプレーンテキストファイルを作成すると、SynProjectはそこから適切な形式のWord文書を作成します。一部のウィザードを使用してコンテンツにアクセスできます。ただし、プレーンファイルとして保存されるため、複数のプログラマーが任意のSCMツール（SVN、Fossil ...）を使用して書き込むことができます。

たとえば、私は現在、巨大で古いDelphiアプリケーション（Delphi 5および6で記述された約2,000,000行のコード）のメンテナンスドキュメントを作成するために使用していますが、以前に利用可能なドキュメントはありません。コードに加えられた変更を（ユニット/クラス/メソッドを引用して）説明すると、ツールはすべてのドキュメントを更新して、それらの変更を反映および追跡します。SynProjectは、いくつかの非常に「デリケートな」規制規則（IEC 62304）に準拠するように設計されていますが、独自の「フラット」設計により、あらゆるプロジェクトに使用できます。

注：SynProjectは現時点では存在していなかったため、質問の後で長い間投稿しています。一見の価値があります。このスレッドは、その質問の参照として定義されています。

于 2011-02-09T08:12:37.140 に答える
6

私の知る限り、Microsoft Sandcastle と容易に互換性のあるツールはありません。

私は個人的にPasDocを使用して大きな成功を収めました。最新の SVN バージョンをビルドすることをお勧めします。現在のリリースでは、複雑なインターフェイス定義が不明瞭になることがあります。

于 2008-10-25T08:14:07.577 に答える
5

試してみてください：-Doxygenドキュメント-Pas2Dox

于 2008-10-25T16:44:23.357 に答える
5

Delphi + JavaDoc = DelphiCodeToDoc

于 2008-10-25T07:49:15.893 に答える
2

Delphi 2005 以降、Delphi コンパイラでビルドされています。XML スタイルのコメントを使用する XMLDoc 標準を使用します。C# と同じように、Sandcastle で処理できると思います。http://dn.codegear.com/article/32770およびhttp://tondrej.blogspot.com/2006/03/xml-documentation-in-delphi-2006.htmlを参照してください。

ドキュメント Delphiも参照してください。

于 2008-10-28T12:32:22.630 に答える
1

DelphiCodeToDocには、継続的インテグレーションツールで使用するためのコマンドラインもあります（たとえば）。

于 2009-12-17T22:55:51.790 に答える
1

質問はかなり古いですが、今日も同じ問題があり、この投稿を見つけました。Delphi 2007 では、次の構文を使用できます。これは、C# のドキュメントと同じようです。

/// <summary>
/// Summary of the function / class
/// </summary>
/// <param name="param1">Description of the parameter param1</param>
/// <param name="param2">Description of the parameter param2</param>
/// <param name="param3">Description of the parameter param3</param>
/// <returns>Description of the return value</returns>
function test(param1, param2, param3: string): string;

の場合<summary>、改行を許可する可能性はないようです。<br />動作しません。

于 2016-01-18T11:59:09.373 に答える
1

Sandcastle は、そのドキュメントを生成するためにアセンブリにアクセスする必要があります。つまり、.net 言語にのみ適用されます (ただし、Delphi.Net が可能かどうかはわかりません)。ただし、Delphi 2007 および 2009 には、C# に非常によく似たインライン XML ドキュメントがあります。プロジェクト オプションで「XML ドキュメントを生成する」オプションをオンにすると、これらのコメントに基づいて XML ドキュメントが作成されます。その後、XSLT を使用して、必要なドキュメント形式を生成できます (これは難しい部分です)。

于 2008-10-27T14:34:27.720 に答える