Share via


CodeProperty.DocComment 属性

获取当前代码模型元素的文档注释。

命名空间:  EnvDTE
程序集:  EnvDTE(在 EnvDTE.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 源代码中的代码元素是只读的。

同样,在进行某些类型的编辑之后,代码模型元素(如类、结构、函数、特性、委托等)的值可能是非确定性的,这意味着不能指望它们的值总是保持不变。有关更多信息,请参见 使用代码模型查找代码 (Visual Basic) 中的“代码模型元素的值可能会更改”一节。

.NET Framework 安全性

请参阅

参考

CodeProperty 接口

EnvDTE 命名空间

其他资源

如何:编译和运行自动化对象模型代码示例

使用代码模型查找代码 (Visual Basic)

使用代码模型查找代码 (Visual C#)