CodeDelegate.Comment プロパティ

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

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

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

構文

'宣言
Property Comment As String

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
CodeDelegate に関連付けられているコメントを含む文字列。

解説

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

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

Comment を設定すると、行指向の構文または区切り形式の構文を使用して、既存のコメントのスタイルの維持を試みます。たとえば、Comment は、行指向の構文の前のインデントを維持したり、コメントがコード要素と接しているか、空白行で区切られているかを判断してそれを維持したりします。

[!メモ]

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