CodeComment Klas

Definitie

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

Overname

Object

CodeObject

CodeComment

Kenmerken

ClassInterfaceAttribute ComVisibleAttribute SerializableAttribute

Voorbeelden

In dit voorbeeld ziet u hoe u een CodeComment opmerking in de broncode weergeeft.

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

Opmerkingen

CodeComment kan worden gebruikt om één regelcommentaar weer te geven.

Een CodeCommentStatement kan een CodeComment en kan bevatten en kan worden behandeld als een instructie en gegenereerd als code binnen een verzameling instructies. Opmerkingen met meerdere regels kunnen worden weergegeven met meerdere CodeCommentStatement objecten.

Als u een opmerking wilt opnemen in een CodeDOM-grafiek die kan worden gegenereerd voor broncode, voegt u een CodeComment aan een CodeCommentStatementtoe en voegt u deze toe aan de instructiesverzameling van een CodeMemberMethod of aan de opmerkingenverzameling van een CodeNamespace of een object dat is afgeleid van CodeTypeMember.

Zie ook

• CodeCommentStatement
• Comments