VCCodeFunction.DocComment プロパティ

現在のコードモデル要素のドキュメントコメントを取得または設定します。

名前空間: Microsoft.VisualStudio.VCCodeModel
アセンブリ: Microsoft.VisualStudio.VCCodeModel (Microsoft.VisualStudio.VCCodeModel.dll 内)

構文

'宣言
Property DocComment As String
    Get
    Set

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

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