CodeComment Classe

Definizione

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

[System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.AutoDispatch)]
[System.Runtime.InteropServices.ComVisible(true)]
[System.Serializable]
public class CodeComment : System.CodeDom.CodeObject

[<System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.AutoDispatch)>]
[<System.Runtime.InteropServices.ComVisible(true)>]
[<System.Serializable>]
type CodeComment = class
    inherit CodeObject

Public Class CodeComment
Inherits CodeObject

Ereditarietà

Object

CodeObject

CodeComment

Attributi

ClassInterfaceAttribute ComVisibleAttribute SerializableAttribute

Esempio

In questo esempio viene illustrato l'uso di per CodeComment rappresentare un commento nel codice sorgente.

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

Commenti

CodeComment può essere utilizzato per rappresentare un commento a riga singola.

Un CodeCommentStatement oggetto può contenere un CodeComment e consente di essere considerato come un'istruzione e generato come codice all'interno di una raccolta di istruzioni. I commenti su più righe possono essere rappresentati con più CodeCommentStatement oggetti.

Per includere un commento in un grafo CodeDOM che può essere generato nel codice sorgente, aggiungere un CodeComment oggetto a un CodeCommentStatementoggetto e aggiungerlo all'insieme di istruzioni di un CodeMemberMethod oggetto o all'insieme comments di un CodeNamespace oggetto o di qualsiasi oggetto che deriva da CodeTypeMember.

Vedi anche

• CodeCommentStatement
• Comments