CodeEvent.Comment プロパティ

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

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

名前空間: EnvDTE80
アセンブリ: EnvDTE80 (EnvDTE80.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
ヘッダーコメントを含む文字列。コメントが指定されていない場合は空の文字列。

解説

取得されたテキストには、コメント構文が含まれません。テキストは、言語のコメント形式に基づいてソースから派生します。たとえば、C# のコメントデリミターは // ですが、Visual Basic のコメントデリミターは、アポストロフィ (') または Rem (注釈の省略形) のいずれかになります。

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

注意

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

例

Comment プロパティの使用方法を次の例に示します。

このプロパティをテストするには

ターゲットプロジェクトを開き、イベントオブジェクト上にカーソルを配置してコードイベント要素を選択します。
アドインを実行します。

public static void Comment(EnvDTE80.DTE2 dte)
{
    TextSelection objTextSel;
    EnvDTE80.CodeEvent codeEvent;
    objTextSel = (TextSelection)dte.ActiveDocument.Selection;
    codeEvent = (EnvDTE80.CodeEvent)objTextSel.ActivePoint.get_CodeElement(vsCMElement.vsCMElementEvent);

    MessageBox.Show("\nComment property: " +
                    codeEvent.Comment, "Testing CodeEvent");
}