CodeEvent.Comment 属性

参考

定义

命名空间:: EnvDTE80

程序集:: EnvDTE80.dll

程序集:

重要

一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。

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

public:
 property System::String ^ Comment { System::String ^ get(); void set(System::String ^ value); };

public:
 property Platform::String ^ Comment { Platform::String ^ get(); void set(Platform::String ^ value); };

[System.Runtime.InteropServices.DispId(35)]
public string Comment { [System.Runtime.InteropServices.DispId(35)] get; [System.Runtime.InteropServices.DispId(35)] set; }

[<System.Runtime.InteropServices.DispId(35)>]
[<get: System.Runtime.InteropServices.DispId(35)>]
[<set: System.Runtime.InteropServices.DispId(35)>]
member this.Comment : string with get, set

Public Property Comment As String

属性值

String

包含标头注释的字符串或空字符串（如果未提供注释）。

属性: DispIdAttribute

示例

下面的示例演示如何使用 Comment 属性。

public static void Comment(EnvDTE80.DTE2 dte)  
{  
    TextSelection objTextSel;  
    EnvDTE80.CodeEvent codeEvent;  
    objTextSel = (TextSelection)dte.ActiveDocument.Selection;  
    codeEvent = (EnvDTE80.CodeEvent)objTextSel.ActivePoint.get_CodeElement(vsCMElement.vsCMElementEvent);  

    MessageBox.Show("\nComment property: " +  
                    codeEvent.Comment, "Testing CodeEvent");  
}

注解

检索的文本不包含任何注释语法。文本基于语言的注释样式从源派生。例如，在 c # 中，注释分隔符是//，但在 Visual Basic 中，它是注释) 的撇号 ( ") 或 Rem (short。

设置后， Comment 属性将尝试使用面向行的语法和分隔语法来维护任何现有注释的样式。在此过程中，它通过确定注释是否涉及代码元素或由空行分隔，来维护面向行的语法之前的任何缩进。

备注

在进行了某些类型的编辑之后，代码模型元素（例如类、结构、函数、特性、委托等）的值可能变为非确定性的，这意味着不能确定它们的值始终保持不变。

适用于

CodeEvent.Comment 属性

此页面有帮助吗?

定义

属性值

示例

注解

适用于