CodeComment Classe

Definição

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

Herança

Object

CodeObject

CodeComment

Atributos

ClassInterfaceAttribute ComVisibleAttribute SerializableAttribute

Exemplos

Este exemplo demonstra o uso de um CodeComment para representar um comentário no código-fonte.

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

Comentários

CodeComment pode ser usado para representar um comentário de linha única.

Um CodeCommentStatement pode conter um CodeComment e permite que ele seja tratado como uma instrução e gerado como código dentro de uma coleção de instruções. Comentários de várias linhas podem ser representados com vários CodeCommentStatement objetos.

Para incluir um comentário em um grafo CodeDOM que pode ser gerado para o código-fonte, adicione um CodeComment a um CodeCommentStatemente adicione-o à coleção de instruções de um CodeMemberMethod ou à coleção de comentários de um CodeNamespace ou qualquer objeto que deriva de CodeTypeMember.

Confira também

• CodeCommentStatement
• Comments