CodeCommentStatement Classe

Definição

Representa uma afirmação composta por um único comentário.

public ref class CodeCommentStatement : System::CodeDom::CodeStatement
[System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.AutoDispatch)]
[System.Runtime.InteropServices.ComVisible(true)]
[System.Serializable]
public class CodeCommentStatement : System.CodeDom.CodeStatement
[<System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.AutoDispatch)>]
[<System.Runtime.InteropServices.ComVisible(true)>]
[<System.Serializable>]
type CodeCommentStatement = class
    inherit CodeStatement
Public Class CodeCommentStatement
Inherits CodeStatement
Herança
CodeCommentStatement
Atributos

Exemplos

Este exemplo demonstra o uso de a CodeCommentStatement 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

Observações

CodeCommentStatement pode ser usado para representar uma declaração de comentário de uma linha. CodeCommentStatement é uma instrução, por isso pode ser inserida numa coleção de statements e aparecerá numa linha própria. CodeCommentStatement pode também ser adicionado à coleção de comentários de CodeNamespace ou a qualquer objeto que derive de CodeTypeMember.

Construtores

Name Description
CodeCommentStatement()

Inicializa uma nova instância da CodeCommentStatement classe.

CodeCommentStatement(CodeComment)

Inicializa uma nova instância da CodeCommentStatement classe usando o comentário especificado.

CodeCommentStatement(String, Boolean)

Inicializa uma nova instância da CodeCommentStatement classe usando o texto especificado e o flag de comentário de documentação.

CodeCommentStatement(String)

Inicializa uma nova instância da CodeCommentStatement classe usando o texto especificado como conteúdo.

Propriedades

Name Description
Comment

Obtém ou define o conteúdo do comentário.

EndDirectives

Obtém um CodeDirectiveCollection objeto que contém diretivas finais.

(Herdado de CodeStatement)
LinePragma

Obtém ou define a linha onde ocorre a instrução de código.

(Herdado de CodeStatement)
StartDirectives

Obtém um CodeDirectiveCollection objeto que contém diretivas de início.

(Herdado de CodeStatement)
UserData

Obtém os dados definidos pelo utilizador para o objeto atual.

(Herdado de CodeObject)

Métodos

Name Description
Equals(Object)

Determina se o objeto especificado é igual ao objeto atual.

(Herdado de Object)
GetHashCode()

Serve como função de hash predefinida.

(Herdado de Object)
GetType()

Obtém o Type da instância atual.

(Herdado de Object)
MemberwiseClone()

Cria uma cópia superficial do atual Object.

(Herdado de Object)
ToString()

Devolve uma cadeia que representa o objeto atual.

(Herdado de Object)

Aplica-se a

Ver também