1

他の人と共有したい多くのエクスポート機能を備えた DLL があります。すべての既存のエクスポート関数をパラメーター、結果などで文書化して、自分で書き留めずに他のユーザーと共有できるようにする方法はありますか?

4

1 に答える 1

4

XE2 などの新しいバージョンの Delphi を使用している場合は、エクスポートされた関数で機能することを確認したドキュメント インサイトがあるかもしれません。コードで、関数/プロシージャの定義をクリックします。たとえば...

procedure DoIt(One: Single; Two: Integer); stdcall;
begin
  //some other code
end;

これをクリックし、カーソルがこの機能内にある場合は、組み合わせを押しますCTRL + ALT + D。このドキュメント機能がある場合は、次のような小さなウィンドウが開きます...

コード ドキュメント ウィンドウ

このウィンドウにいくつかのドキュメントを入力すると、これが自動的にコードに挿入されます。

/// <summary>
///   This procedure does this and then that
/// </summary>
/// <param name="One">
///   This is parameter one
/// </param>
/// <param name="Two">
///   This is parameter two
/// </param>
/// <remarks>
///   Use DoIt to do this and that within your Delphi project.
/// </remarks>
procedure DoIt(One: Single; Two: Integer); stdcall;
begin
  //some other code
end;

このドキュメントとこれをさらに使用する方法の詳細については、こちらを参照してください。

これを使用する際の優れた点は、ソース内の文書化されたクラス、関数、型などのいずれかにマウスを合わせると、文書化された情報を含む小さなヒント ウィンドウが表示されることです。DLL での使用に関しては、私は行ったことはありませんが、そこでも使用できると確信しています。

また、このウィンドウを使用せずに、この形式のドキュメンテーションをコードに直接入力することもできます。つまり、基本的にどのバージョンの Delphi でも実行できます。これは、他の言語でも使用されている Microsoft の標準形式です。

残念ながら、Delphi のどのバージョン/エディションがそれをサポートしているか正確にはわかりません。

于 2013-08-24T19:10:31.843 に答える