CodeComment Clase

Definición

Espacio de nombres:

System.CodeDom

Ensamblado:

System.CodeDom.dll

Paquete:

System.CodeDom v9.0.0-rc.2.24473.5

Source:

CodeComment.cs

Representa un comentario.

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

public class CodeComment : System.CodeDom.CodeObject

type CodeComment = class
    inherit CodeObject

Public Class CodeComment
Inherits CodeObject

Herencia

Object

CodeObject

CodeComment

Ejemplos

En este ejemplo se muestra el uso de un CodeComment para representar un comentario en el código fuente.

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

Comentarios

CodeComment se puede usar para representar un solo comentario de línea.

Un CodeCommentStatement puede contener un CodeComment y permite que se trate como una instrucción y se genere como código dentro de una colección de instrucciones. Los comentarios de varias líneas se pueden representar con varios objetos CodeCommentStatement.

Para incluir un comentario en un gráfico CodeDOM que se puede generar al código fuente, agregue un CodeComment a un CodeCommentStatementy agréguelo a la colección de instrucciones de un CodeMemberMethod o a la colección de comentarios de un CodeNamespace o cualquier objeto que derive de CodeTypeMember.

Constructores

CodeComment()	Inicializa una nueva instancia de la clase CodeComment.
CodeComment(String, Boolean)	Inicializa una nueva instancia de la clase CodeComment con el texto y la marca de comentario de documentación especificados.
CodeComment(String)	Inicializa una nueva instancia de la clase CodeComment con el texto especificado como contenido.

Propiedades

DocComment	Obtiene o establece un valor que indica si el comentario es un comentario de documentación.
Text	Obtiene o establece el texto del comentario.
UserData	Obtiene los datos definibles por el usuario para el objeto actual. (Heredado de CodeObject)

Métodos

Equals(Object)	Determina si el objeto especificado es igual al objeto actual. (Heredado de Object)
GetHashCode()	Actúa como función hash predeterminada. (Heredado de Object)
GetType()	Obtiene el Type de la instancia actual. (Heredado de Object)
MemberwiseClone()	Crea una copia superficial del Objectactual. (Heredado de Object)
ToString()	Devuelve una cadena que representa el objeto actual. (Heredado de Object)

Consulte también

• CodeCommentStatement
• Comments