CodeComment Klasse

Definition

Namespace:

System.CodeDom

Assembly:

System.CodeDom.dll

Paket:

System.CodeDom v9.0.0-rc.2.24473.5

Quelle:

CodeComment.cs

Stellt einen Kommentar dar.

public ref class CodeComment : System::CodeDom::CodeObject

public class CodeComment : System.CodeDom.CodeObject

type CodeComment = class
    inherit CodeObject

Public Class CodeComment
Inherits CodeObject

Vererbung

Object

CodeObject

CodeComment

Beispiele

In diesem Beispiel wird die Verwendung eines CodeComment zum Darstellen eines Kommentars im Quellcode veranschaulicht.

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

Hinweise

CodeComment kann verwendet werden, um einen einzelnen Zeilenkommentar darzustellen.

Ein CodeCommentStatement kann eine CodeComment enthalten und ermöglicht die Behandlung als Anweisung und generiert als Code in einer Sammlung von Anweisungen. Mehrzeilige Kommentare können mit mehreren CodeCommentStatement Objekten dargestellt werden.

Um einen Kommentar in ein CodeDOM-Diagramm einzuschließen, das im Quellcode generiert werden kann, fügen Sie einem CodeCommentStatementeine CodeComment hinzu, und fügen Sie diesen der Anweisungsauflistung eines CodeMemberMethod oder der Kommentarauflistung eines CodeNamespace oder eines Objekts hinzu, das von CodeTypeMemberabgeleitet wird.

Konstruktoren

CodeComment()	Initialisiert eine neue Instanz der CodeComment Klasse.
CodeComment(String, Boolean)	Initialisiert eine neue Instanz der CodeComment Klasse mithilfe des angegebenen Text- und Dokumentationskommentar-Flags.
CodeComment(String)	Initialisiert eine neue Instanz der CodeComment Klasse mit dem angegebenen Text als Inhalt.

Eigenschaften

DocComment	Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob der Kommentar ein Dokumentationskommentar ist.
Text	Ruft den Text des Kommentars ab oder legt den Text fest.
UserData	Ruft die vom Benutzer definierbaren Daten für das aktuelle Objekt ab. (Geerbt von CodeObject)

Methoden

Equals(Object)	Bestimmt, ob das angegebene Objekt dem aktuellen Objekt entspricht. (Geerbt von Object)
GetHashCode()	Dient als Standardhashfunktion. (Geerbt von Object)
GetType()	Ruft die Type der aktuellen Instanz ab. (Geerbt von Object)
MemberwiseClone()	Erstellt eine flache Kopie der aktuellen Object. (Geerbt von Object)
ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object)

Weitere Informationen

• CodeCommentStatement
• Comments