29

本格的な文書化が必要なコードがあり、C#/.NET のコード内 XML ドキュメントと同様の機能が Embarcadero Delphi で利用できるかどうかを尋ねたいと思いました。私の目的は、Delphi XE3 のオートコンプリートで強調表示される方法で、特定のメソッドを正しく使用する方法に関する何らかの情報を表示することです。

このようなもの（C＃）：

/// <summary>
/// Some useful information helping other developers use this method correctly
/// </summary>
public static void ADocumentedMethod();

Delphi XE3 はこのようなものをサポートしていますか?

読んでくれてありがとう。

4

1 に答える 1

40

この機能はXML ドキュメンテーション コメントと呼ばれ、ここに文書化されています。同等の .net 機能に基づいて密接にモデル化されているように見えるので、すぐに慣れるはずです。

ドキュメントには、次の例が含まれています。

/// <summary> Removes the specified item from the collection
/// </summary>
/// <param name="Item">The item to remove
/// </param>
/// <param name="Collection">The group containing the item
/// </param>
/// <remarks>
/// If parameter "Item" is null, an exception is raised.
/// <see cref="EArgumentNilException"/>
/// </remarks>
/// <returns>True if the specified item is successfully removed;
/// otherwise False is returned.
/// </returns>
function RemoveItem(Item: Pointer; Collection: Pointer): Boolean;
begin
  // Non-XML DOC comment
  // ...
end;

これにより、次のヘルプ インサイト ヒントが得られます。

ここに画像の説明を入力

また、ドキュメントを処理および使用するには、他にもさまざまな方法があります。

于 2013-03-12T12:57:15.527 に答える