CodeComment Classe

Definição

Namespace:

System.CodeDom

Assembly:

System.CodeDom.dll

Pacote:

System.CodeDom v8.0.0

Origem:

CodeComment.cs

Representa um comentário.

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

public class CodeComment : System.CodeDom.CodeObject

type CodeComment = class
    inherit CodeObject

Public Class CodeComment
Inherits CodeObject

Herança

Object

CodeObject

CodeComment

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.

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

Comentários

CodeCommentpode ser usado para representar um único comentário em linha.

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 derivado de CodeTypeMember.

Construtores

CodeComment()	Inicializa uma nova instância da classe CodeComment.
CodeComment(String)	Inicializa uma nova instância da classe CodeComment com o texto especificado como conteúdo.
CodeComment(String, Boolean)	Inicializa uma nova instância da classe CodeComment usando o texto e o sinalizador de comentário de documentação especificados.

Propriedades

DocComment	Obtém ou define um valor que indica se o comentário é um comentário de documentação.
Text	Obtém ou define o texto do comentário.
UserData	Obtém os dados definidos pelo usuário para o objeto atual. (Herdado de CodeObject)

Métodos

Equals(Object)	Determina se o objeto especificado é igual ao objeto atual. (Herdado de Object)
GetHashCode()	Serve como a função de hash padrão. (Herdado de Object)
GetType()	Obtém o Type da instância atual. (Herdado de Object)
MemberwiseClone()	Cria uma cópia superficial do Object atual. (Herdado de Object)
ToString()	Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object)

Confira também

• CodeCommentStatement
• Comments