CodeDelegate.DocComment プロパティ

[アーティクル]
10/28/2012

CodeDelegate 要素のドキュメントコメントを設定または取得します。

名前空間: EnvDTE
アセンブリ: EnvDTE (EnvDTE.dll 内)

構文

'宣言
Property DocComment As String

string DocComment { get; set; }

property String^ DocComment {
    String^ get ();
    void set (String^ value);
}

abstract DocComment : string with get, set

function get DocComment () : String
function set DocComment (value : String)

プロパティ値

型 : System.String
デリゲートのドキュメントコメントを含む文字列。

解説

コード内にデリゲートの特殊なドキュメントコメントや属性がある場合、DocComment はそれを返します。コードモデルを実装している言語にドキュメントコメントの機構がない場合や、コード要素に関連付けられているドキュメントコメントがない場合、DocComment では空の文字列が返されます。

[!メモ]

特定の種類の編集を行った後に、クラス、構造体、関数、属性、デリゲートなどのコードモデル要素の値を決定できないことがあります。つまり、これらの要素の値は、信頼できる値ではなく、常に同じ値になるとは限りません。詳細については、「コードモデルを使用したコードの調査 (Visual Basic)」で、コードモデル要素値を変更する方法についての説明を参照してください。