CodeCommentStatement 类

定义

命名空间:

System.CodeDom

程序集:

System.CodeDom.dll

包:

System.CodeDom v8.0.0

Source:

CodeCommentStatement.cs

表示由单个注释构成的语句。

public ref class CodeCommentStatement : System::CodeDom::CodeStatement

public class CodeCommentStatement : System.CodeDom.CodeStatement

type CodeCommentStatement = class
    inherit CodeStatement

Public Class CodeCommentStatement
Inherits CodeStatement

继承

Object

CodeObject

CodeStatement

CodeCommentStatement

示例

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

// 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

注解

CodeCommentStatement可用于表示单行注释语句。 CodeCommentStatement 是语句，因此可以将其插入语句集合中，并且将显示在其自己的行中。 CodeCommentStatement还可以添加到 的注释集合或派生自 CodeTypeMember的任何 对象的注释集合CodeNamespace中。

构造函数

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

属性

Comment	获取或设置注释的内容。
EndDirectives	获取包含结束指令的 CodeDirectiveCollection 对象。 (继承自 CodeStatement)
LinePragma	获取或设置代码语句所在的行。 (继承自 CodeStatement)
StartDirectives	获取包含开始指令的 CodeDirectiveCollection 对象。 (继承自 CodeStatement)
UserData	获取当前对象的用户可定义数据。 (继承自 CodeObject)

方法

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

另请参阅

• CodeComment