CodeComment Class

 

Represents a comment.

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

System.Object
  System.CodeDom.CodeObject
    System.CodeDom.CodeComment

<SerializableAttribute>
<ClassInterfaceAttribute(ClassInterfaceType.AutoDispatch)>
<ComVisibleAttribute(True)>
Public Class CodeComment
	Inherits CodeObject

NameDescription
System_CAPS_pubmethodCodeComment()

Initializes a new instance of the CodeComment class.

System_CAPS_pubmethodCodeComment(String)

Initializes a new instance of the CodeComment class with the specified text as contents.

System_CAPS_pubmethodCodeComment(String, Boolean)

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

NameDescription
System_CAPS_pubpropertyDocComment

Gets or sets a value that indicates whether the comment is a documentation comment.

System_CAPS_pubpropertyText

Gets or sets the text of the comment.

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.)

CodeComment can be used to represent a single line comment.

A CodeCommentStatement can contain a CodeComment and allows it to be treated as a statement and generated as code within a collection of statements. Multi-line comments can be represented with multiple CodeCommentStatement objects.

To include a comment in a CodeDOM graph that can be generated to source code, add a CodeComment to a CodeCommentStatement, and add this to the statements collection of a CodeMemberMethod or to the comments collection of a CodeNamespace or any object that derives from CodeTypeMember.

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

' 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

.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: