CodeComment 类

定义

命名空间:

System.CodeDom

程序集:

System.CodeDom.dll

包:

System.CodeDom v8.0.0

Source:

CodeComment.cs

表示注释。

public ref class CodeComment : System::CodeDom::CodeObject

public class CodeComment : System.CodeDom.CodeObject

type CodeComment = class
    inherit CodeObject

Public Class CodeComment
Inherits CodeObject

继承

Object

CodeObject

CodeComment

示例

此示例演示如何使用 CodeComment 在源代码中表示注释。

// Create a CodeComment with some example comment text.

// The text of the comment.
// Whether the comment is a comment intended for documentation purposes.
CodeComment^ comment = gcnew CodeComment( "This comment was generated from a System.CodeDom.CodeComment",false );

// Create a CodeCommentStatement that contains the comment, in order
// to add the comment to a CodeTypeDeclaration Members collection.
CodeCommentStatement^ commentStatement = gcnew CodeCommentStatement( comment );

// A C# code generator produces the following source code for the preceeding example code:
// // This comment was generated from a System.CodeDom.CodeComment

// Create a CodeComment with some example comment text.
CodeComment comment = new CodeComment(
    // The text of the comment.
    "This comment was generated from a System.CodeDom.CodeComment",
    // Whether the comment is a comment intended for documentation purposes.
    false );

// Create a CodeCommentStatement that contains the comment, in order
// to add the comment to a CodeTypeDeclaration Members collection.
CodeCommentStatement commentStatement = new CodeCommentStatement( comment );

// A C# code generator produces the following source code for the preceeding example code:

// // This comment was generated from a System.CodeDom.CodeComment

     ' Create a CodeComment with some example comment text.
     Dim comment As New CodeComment( _
        "This comment was generated from a System.CodeDom.CodeComment", _
        False) ' Whether the comment is a documentation comment.
     
     ' Create a CodeCommentStatement that contains the comment, in order
     ' to add the comment to a CodeTypeDeclaration Members collection.
     Dim commentStatement As New CodeCommentStatement(comment)	

     ' A Visual Basic code generator produces the following source code for the preceeding example code:

     ' 'This comment was generated from a System.CodeDom.CodeComment

注解

CodeComment可用于表示单个行注释。

可以 CodeCommentStatement 包含 ， CodeComment 并允许将其视为语句，并在语句集合中作为代码生成。 多行注释可以用多个 CodeCommentStatement 对象表示。

若要在 CodeDOM 图中包含可生成到源代码的注释，请将 添加到 CodeCommentCodeCommentStatement，并将它添加到 的 语句集合CodeMemberMethod或派生自 CodeTypeMember的任何 对象的注释集合CodeNamespace中。

构造函数

CodeComment()	初始化 CodeComment 类的新实例。
CodeComment(String)	使用指定的文本作为内容来初始化 CodeComment 类的新实例。
CodeComment(String, Boolean)	使用指定的文本和文档注释标志初始化 CodeComment 类的新实例。

属性

DocComment	获取或设置一个值，该值指示注释是否是文档注释。
Text	获取或设置注释文本。
UserData	获取当前对象的用户可定义数据。 (继承自 CodeObject)

方法

Equals(Object)	确定指定对象是否等于当前对象。 (继承自 Object)
GetHashCode()	作为默认哈希函数。 (继承自 Object)
GetType()	获取当前实例的 Type。 (继承自 Object)
MemberwiseClone()	创建当前 Object 的浅表副本。 (继承自 Object)
ToString()	返回表示当前对象的字符串。 (继承自 Object)

另请参阅

• CodeCommentStatement
• Comments