CodeEvent.DocComment 属性

项目
10/25/2012

获取或设置与代码事件元素关联的文档注释。

命名空间： 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)

属性值

类型：System.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");
}