2013-03-12 27 views
24

私はいくつかの深刻な文書化が必要なコードを持っており、C#/ .NETのインコードXMLドキュメントに類似した機能がEmbarcadero Delphiで利用可能かどうかを尋ねたがっています。 私の目的は、特定のメソッドをDelphi XE3のオートコンプリートで強調表示される方法で正しく使用する方法に関する何らかの情報を表示することです。このようなDelphiでメソッドに注釈を付ける?

何か(C#の):

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

はこのようなデルファイXE3のサポートに何かをしていますか?

ありがとうございます。

+0

あなたはどのDelphi XE3のディストリビューションをお持ちですか?この情報をあなたの質問に含めることができますか? – TLama

+2

@TLamaは本当に重要ではありません。AFAIK /// XML-docはD2010以降、すべてのSKUで使用できますが、少しバグがあるようです... – ain

+2

@ain、[Documentation Insight'] (http://edn.embarcadero.com/cs/article/41911)私が覚えている限り、Delphiのより安いディストリビューションには大きな制限がありましたが、そうではありませんでしたか? – TLama

答えて

32

この機能の名前は、となります。XMLドキュメントのコメントdocumented hereです。それはあなたがそれで家にいるべきであるように等価なネットの特徴で密接にモデル化されたように見えます。このヘルプ洞察ヒントになり

/// <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; 

ドキュメントはこの例が含まれ

enter image description here

をし、プロセスやドキュメントを消費する他のさまざまな方法があります。

+1

これは完璧です!どうもありがとうございました!私はグーグルでこれを見つけなかったため、ちょっと馬鹿だと感じています。 – FLClover

+0

また、このXMLドキュメントは、外部ユニットで表示するためにユニットの 'interface'セクションに存在する必要があります。 – Paul

関連する問題