VCCodeFunction.Comment プロパティ

コード要素に関連付けられたコメントを取得または設定します。

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

構文

'宣言
Property Comment As String
'使用
Dim instance As VCCodeFunction
Dim value As String

value = instance.Comment

instance.Comment = value

string Comment { get; set; }

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

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

コード要素に関連付けられたコメント。

Comment は、ヘッダーコメントを設定または取得します。取得のときには、テキストにコメント構文は含まれていません。コメントテキストは、コード要素を含んでいるソースドキュメントから派生します。収集されるヘッダーコメント行の数は、コメントが書かれた言語により異なります。

設定された場合、Comment は既存のコメントのスタイルを維持しようとします。たとえば、行指向の構文と区切り形式の構文のどちらが使われているか、行指向の構文の前のインデント、コメントがコード要素と接しているか間に空白行があるかなどのスタイルが維持されます。

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