CodeEnum.DocComment プロパティ

CodeEnum 要素のドキュメントコメントを取得します。

名前空間: 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 のソースコードのコード要素に対しては、このプロパティは読み取り専用です。

[!メモ]

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

直前の呼び出し元に対する完全な信頼。このメンバーは、部分的に信頼されているコードから使用することはできません。詳細については、「部分信頼コードからのライブラリの使用」を参照してください。