CodeComment Class
Assembly: System (in system.dll)
'Declaration <SerializableAttribute> _ <ClassInterfaceAttribute(ClassInterfaceType.AutoDispatch)> _ <ComVisibleAttribute(True)> _ Public Class CodeComment Inherits CodeObject 'Usage Dim instance As CodeComment
/** @attribute SerializableAttribute() */ /** @attribute ClassInterfaceAttribute(ClassInterfaceType.AutoDispatch) */ /** @attribute ComVisibleAttribute(true) */ public class CodeComment extends CodeObject
SerializableAttribute ClassInterfaceAttribute(ClassInterfaceType.AutoDispatch) ComVisibleAttribute(true) public class CodeComment extends CodeObject
Not applicable.
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
// Create a CodeComment with some example comment text.
CodeComment comment = new CodeComment("This comment was generated "
+ "from a System.CodeDom.CodeComment", false);
// The text of the comment.
// Whether the comment is a comment intended for documentation purposes.
// Create a CodeCommentStatement that contains the comment, in order
// to add the comment to a CodeTypeDeclaration Members collection.
CodeCommentStatement commentStatement = new
CodeCommentStatement(comment);
// A VJ# code generator produces the following source code for the
// preceeding example code:
// This comment was generated from a System.CodeDom.CodeComment
Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.