CodeProperty.Comment プロパティ

[アーティクル]
08/09/2011

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

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

構文

'宣言
Property Comment As String
    Get
    Set

string Comment { get; set; }

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

abstract Comment : string with get, set

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

プロパティ値

型: System.String
コード要素に関連付けられたコメントを表す文字列。

解説

Comment は、ヘッダーコメントを設定または取得します。取得のときには、テキストにコメント構文は含まれていません。

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

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

注意

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