0

重複の可能性:
javadoc または c# xml doc に似た Delphi のコード ドキュメント

私は、RAD Studio Delphi XE2 のドキュメンテーション機能を、私のグローバル ソース (ビジネス ルール、コンポーネント/コントロールなどのライブラリ) のほとんどで利用しています。これにより、次のように、ソース コード内のさまざまな宣言の直前にコメント付きのテキストが配置されます。

type
  ///   <summary>
  ///     This class is used for this and that.
  ///   </summary>
  TMyObject = class(TObject)
  ....

あるいは

/// <summary>
///   This function does this and that.
/// </summary>
/// <returns>
///   This is the result of what DoSomething produces.
/// </returns>
/// <remarks>
///   DoSomething is only a sample function for demonstration purposes.
/// </remarks>
function DoSomething: String;

私がこれを行っている主な理由は、シンボルにカーソルを合わせると、洞察が表示されるときに、このドキュメント テキストが含まれるようにするためです。たとえば、完全に別の単元で、テキストDoSomethingが使用されている場所にカーソルを合わせると、このドキュメントに書かれている正確なテキストを含むヒント ボックスが表示されます。

ヒント: または のいずれCtrl+Shift+Dかを押すCtrl+Alt+Dと (別の PC で両方を見たことがある)、作業を容易にするためのウィンドウが開きます。Ctrl+Shift+S保存を押したときに偶然これに出くわしましたが、誤ってD.

このドキュメントを CHM ヘルプ ファイルにエクスポートする方法を教えてください。私のライブラリにリンクされたヘルプ ファイルを作成して、開発者がコードで F1 を使用し、コードの動作の説明を確認できるようにしたいと考えています。標準の Delphi ソース ドキュメント（および他のほとんどの言語）と同様です。

4

1 に答える 1

2

これは CHM ファイルではありませんが、Delphi Enterprise 以上を使用している場合、IDE は適切にフォーマットされたソース コード コメントを使用してドキュメントを作成することができます。

于 2012-06-10T03:26:07.280 に答える