CodeComment Class
Represents a comment.
Namespace: System.CodeDom
Assembly: System (in System.dll)
The CodeComment type exposes the following members.
| Name | Description | |
|---|---|---|
 | CodeComment() | Initializes a new instance of the CodeComment class. |
| CodeComment(String) | Initializes a new instance of the CodeComment class with the specified text as contents. |
| CodeComment(String, Boolean) | Initializes a new instance of the CodeComment class using the specified text and documentation comment flag. |
| Name | Description | |
|---|---|---|
| DocComment | Gets or sets a value that indicates whether the comment is a documentation comment. |
| Text | Gets or sets the text of the comment. |
| UserData | Gets the user-definable data for the current object. (Inherited from CodeObject.) |
| Name | Description | |
|---|---|---|
| Equals(Object) | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | 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. 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
Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
