CodeCommentStatement Class

 

Represents a statement consisting of a single comment.

Namespace:   System.CodeDom
Assembly:  System (in System.dll)

System::Object
  System.CodeDom::CodeObject
    System.CodeDom::CodeStatement
      System.CodeDom::CodeCommentStatement

[SerializableAttribute]
[ClassInterfaceAttribute(ClassInterfaceType::AutoDispatch)]
[ComVisibleAttribute(true)]
public ref class CodeCommentStatement : CodeStatement

NameDescription
System_CAPS_pubmethodCodeCommentStatement()

Initializes a new instance of the CodeCommentStatement class.

System_CAPS_pubmethodCodeCommentStatement(CodeComment^)

Initializes a new instance of the CodeCommentStatement class using the specified comment.

System_CAPS_pubmethodCodeCommentStatement(String^)

Initializes a new instance of the CodeCommentStatement class using the specified text as contents.

System_CAPS_pubmethodCodeCommentStatement(String^, Boolean)

Initializes a new instance of the CodeCommentStatement class using the specified text and documentation comment flag.

NameDescription
System_CAPS_pubpropertyComment

Gets or sets the contents of the comment.

System_CAPS_pubpropertyEndDirectives

Gets a CodeDirectiveCollection object that contains end directives.(Inherited from CodeStatement.)

System_CAPS_pubpropertyLinePragma

Gets or sets the line on which the code statement occurs. (Inherited from CodeStatement.)

System_CAPS_pubpropertyStartDirectives

Gets a CodeDirectiveCollection object that contains start directives.(Inherited from CodeStatement.)

System_CAPS_pubpropertyUserData

Gets the user-definable data for the current object.(Inherited from CodeObject.)

NameDescription
System_CAPS_pubmethodEquals(Object^)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

CodeCommentStatement can be used to represent a single-line comment statement. CodeCommentStatement is a statement, so it can be inserted into a statements collection and will appear on its own line. CodeCommentStatement can also be added to the comments collection of CodeNamespace or any object that derives from CodeTypeMember.

This example demonstrates using a CodeCommentStatement to represent a comment in source code.

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

.NET Framework
Available since 1.1

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: