CodeEvent.DocComment プロパティ
コード イベント要素に関連付けられたドキュメント コメントを取得または設定します。
名前空間: EnvDTE80
アセンブリ: EnvDTE80 (EnvDTE80.dll 内)
構文
'宣言
Property DocComment As String
string DocComment { get; set; }
property String^ DocComment {
String^ get ();
void set (String^ value);
}
abstract DocComment : string with get, set
function get DocComment () : String
function set DocComment (value : String)
プロパティ値
型 : String
コード イベント要素に関連付けられたドキュメント コメントを含む文字列。コメントが指定されていない場合は空の文字列。
解説
コメントが指定されていない場合、またはコードを実装する言語にドキュメント コメントの機構がない場合は、空の文字列が返されます。
注意
特定の種類の編集を行った後に、クラス、構造体、関数、属性、デリゲートなどのコード モデル要素の値を決定できないことがあります。つまり、これらの要素の値は、信頼できる値ではなく、常に同じ値になるとは限りません。詳細については、「コード モデルを使用したコードの調査 (Visual Basic)」で、コード モデル要素値を変更する方法についての説明を参照してください。
例
DocComment プロパティを使用する方法を次の例に示します。
このプロパティをテストするには
ターゲット プロジェクトを開き、イベント オブジェクト上にカーソルを配置してコード イベント要素を選択します。
アドインを実行します。
public static void DocComment(EnvDTE80.DTE2 dte)
{
TextSelection objTextSel;
EnvDTE80.CodeEvent codeEvent;
objTextSel = (TextSelection)dte.ActiveDocument.Selection;
codeEvent = (EnvDTE80.CodeEvent)objTextSel.ActivePoint.get_CodeElement(vsCMElement.vsCMElementEvent);
MessageBox.Show("\nDocComment property: " +
codeEvent.DocComment, "Testing CodeEvent");
}
.NET Framework セキュリティ
- 直前の呼び出し元に対する完全な信頼。このメンバーは、部分的に信頼されているコードから使用することはできません。詳細については、「部分信頼コードからのライブラリの使用」を参照してください。
参照
関連項目
その他の技術情報
方法 : オートメーション オブジェクト モデルのコード例をコンパイルおよび実行する