Share via


CodeProperty.Comment 属性

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

命名空间:  EnvDTE
程序集:  EnvDTE(在 EnvDTE.dll 中)

语法

声明
Property Comment As String
string Comment { get; set; }
property String^ Comment {
    String^ get ();
    void set (String^ value);
}
abstract Comment : string with get, set
function get Comment () : String 
function set Comment (value : String)

属性值

类型:String
一个表示与代码元素关联的注释的字符串。

备注

Comment 设置或返回标头注释。 返回时,文本不包含任何注释语法。

从包含代码元素的源文档派生出注释文本。 收集的标题注释行数将因编写注释所使用的语言而异。

设置时,Comment 尝试保持任何现有注释的样式,所采用的方法为:使用面向行的语法和分隔语法;保持在面向行的语法之前的任何缩进;确定注释与代码元素相接触还是用空行隔开等。

备注

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

.NET Framework 安全性

请参阅

参考

CodeProperty 接口

EnvDTE 命名空间

其他资源

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

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

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