CodeClass2.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
ドキュメント コメントを表す文字列。
解説
DocComment プロパティは、コード クラス内に特殊なドキュメント コメントや属性がある場合にそれを返します。 コード モデルを実装している言語にドキュメント コメントの機構がない場合や、コード クラスに関連付けられているドキュメント コメントがない場合、DocComment では空の文字列が返されます。
注意
特定の種類の編集を行った後に、クラス、構造体、関数、属性、デリゲートなどのコード モデル要素の値を決定できないことがあります。つまり、これらの要素の値は、信頼できる値ではなく、常に同じ値になるとは限りません。詳細については、「コード モデルを使用したコードの調査 (Visual Basic)」で、コード モデル要素値を変更する方法についての説明を参照してください。
例
[C#]
public void CodeClass2DocCommentExample(DTE2 dte2)
{
// Before running this example, open a code document from a project
// and place the insertion point within a class definition.
try
{ // Get the CodeClass2 at the insertion point.
TextSelection sel =
(TextSelection)dte2.ActiveDocument.Selection;
CodeClass2 cls = (CodeClass2)sel.ActivePoint.get_CodeElement(
vsCMElement.vsCMElementClass);
// Set the document comment for the CodeClass.
cls.DocComment = "<doc>This is a DocComment\r\n</doc>";
}
catch (Exception e)
{
Console.WriteLine(e.Message);
}
}
.NET Framework セキュリティ
- 直前の呼び出し元に対する完全な信頼。このメンバーは、部分的に信頼されているコードから使用することはできません。詳細については、「部分信頼コードからのライブラリの使用」を参照してください。
参照
関連項目
その他の技術情報
方法 : オートメーション オブジェクト モデルのコード例をコンパイルおよび実行する