CodeInterface.Comment 属性

获取或设置与 CodeInterface 关联的注释。

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

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

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

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

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

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