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

Observações

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

A CodeCommentStatement pode conter a CodeComment e permite que seja tratada como uma instrução e gerada como código dentro de uma coleção de sentenças. Comentários multi-linha podem ser representados com múltiplos CodeCommentStatement objetos.

Para incluir um comentário num grafo CodeDOM que possa ser gerado para código-fonte, adicione a CodeComment a a CodeCommentStatementa , e adicione isto à coleção de instruções de a CodeMemberMethod ou à coleção de comentários de a CodeNamespace ou qualquer objeto que derive de CodeTypeMember.

Ver também

• CodeCommentStatement
• Comments