CodeComment Class

Definition

Stellt einen Kommentar dar.Represents a comment.

public ref class CodeComment : System::CodeDom::CodeObject
public class CodeComment : System.CodeDom.CodeObject
[System.Runtime.InteropServices.ComVisible(true)]
[System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.AutoDispatch)]
[System.Serializable]
public class CodeComment : System.CodeDom.CodeObject
type CodeComment = class
    inherit CodeObject
Public Class CodeComment
Inherits CodeObject
Inheritance
CodeComment
Attributes

Examples

Dieses Beispiel veranschaulicht die Verwendung eines CodeComment, um einen Kommentar im Quellcode darzustellen.This example demonstrates using a CodeComment 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
// 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

Remarks

CodeComment kann zur Darstellung eines einzeiligen Kommentars verwendet werden.CodeComment can be used to represent a single line comment.

Eine CodeCommentStatement kann eine CodeComment enthalten und ermöglicht, dass Sie als-Anweisung behandelt und als Code in einer Auflistung von-Anweisungen generiert wird.A CodeCommentStatement can contain a CodeComment and allows it to be treated as a statement and generated as code within a collection of statements. Mehrzeilige Kommentare können mit mehreren CodeCommentStatement Objekten dargestellt werden.Multi-line comments can be represented with multiple CodeCommentStatement objects.

Wenn Sie einen Kommentar in ein CodeDOM-Diagramm einschließen möchten, der in den Quellcode generiert werden kann, fügen Sie einen-CodeComment zu einem CodeCommentStatementhinzu, und fügen Sie diesen der Statements-Auflistung einer CodeMemberMethod oder der Comments-Auflistung einer CodeNamespace oder eines beliebigen Objekts hinzu, das von CodeTypeMemberabgeleitet ist.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.

Constructors

CodeComment()

Initialisiert eine neue Instanz der Klasse CodeComment.Initializes a new instance of the CodeComment class.

CodeComment(String)

Initialisiert eine neue Instanz der CodeComment-Klasse mit dem angegebenen Text als Inhalt.Initializes a new instance of the CodeComment class with the specified text as contents.

CodeComment(String, Boolean)

Initialisiert eine neue Instanz der CodeComment-Klasse unter Verwendung des angegebenen Textes und des angegebenen Flags für Dokumentationskommentare.Initializes a new instance of the CodeComment class using the specified text and documentation comment flag.

Properties

DocComment

Ruft einen Wert ab, der angibt, ob es sich bei dem Kommentar um einen Dokumentationskommentar handelt, oder legt diesen fest.Gets or sets a value that indicates whether the comment is a documentation comment.

Text

Ruft den Text des Kommentars ab oder legt diesen fest.Gets or sets the text of the comment.

UserData

Ruft die benutzerdefinierbaren Daten für das aktuelle Objekt ab.Gets the user-definable data for the current object.

(Inherited from CodeObject)

Methods

Equals(Object)

Bestimmt, ob das angegebene Objekt mit dem aktuellen Objekt identisch ist.Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode()

Fungiert als Standardhashfunktion.Serves as the default hash function.

(Inherited from Object)
GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Inherited from Object)

Applies to

See also