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 安全性
- 对直接调用方的完全信任。此成员不能由部分信任的代码使用。有关详细信息，请参阅通过部分受信任的代码使用库。