CodeEvent.Comment プロパティ
更新 : 2007 年 11 月
コード イベント要素に関連付けられたヘッダー コメントを取得または設定します。
名前空間 : EnvDTE80
アセンブリ : EnvDTE80 (EnvDTE80.dll 内)
構文
'宣言
Property Comment As String
'使用
Dim instance As CodeEvent
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)
プロパティ値
型 : 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");
}
アクセス許可
- 直前の呼び出し元に対する完全な信頼。このメンバは、部分的に信頼されているコードから使用することはできません。詳細については、「部分信頼コードからのライブラリの使用」を参照してください。
参照
参照
その他の技術情報
方法 : オートメーション オブジェクト モデルのコード例をコンパイルおよび実行する