CodeCommentStatement Classe

Définition

Espace de noms:

System.CodeDom

Assembly:

System.CodeDom.dll

Paquet:

System.CodeDom v8.0.0

Source:

CodeCommentStatement.cs

Représente une instruction constituée d'un seul commentaire.

public ref class CodeCommentStatement : System::CodeDom::CodeStatement

public class CodeCommentStatement : System.CodeDom.CodeStatement

type CodeCommentStatement = class
    inherit CodeStatement

Public Class CodeCommentStatement
Inherits CodeStatement

Héritage

Object

CodeObject

CodeStatement

CodeCommentStatement

Exemples

Cet exemple illustre l’utilisation d’un CodeCommentStatement pour représenter un commentaire dans le code source.

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

Remarques

CodeCommentStatementpeut être utilisé pour représenter une instruction à commentaire de ligne unique. CodeCommentStatement étant une instruction, elle peut être insérée dans une collection d’instructions et s’affiche sur sa propre ligne. CodeCommentStatement peut également être ajouté à la collection de commentaires de CodeNamespace ou à tout objet dérivé de CodeTypeMember.

Constructeurs

CodeCommentStatement()	Initialise une nouvelle instance de la classe CodeCommentStatement.
CodeCommentStatement(CodeComment)	Initialise une nouvelle instance de la classe CodeCommentStatement avec le commentaire spécifié.
CodeCommentStatement(String)	Initialise une nouvelle instance de la classe CodeCommentStatement avec le texte spécifié comme contenu.
CodeCommentStatement(String, Boolean)	Initialise une nouvelle instance de la classe CodeCommentStatement avec le texte et l'indicateur de commentaire de documentation spécifiés.

Propriétés

Comment	Obtient ou définit le contenu du commentaire.
EndDirectives	Obtient un objet CodeDirectiveCollection qui contient des directives de fin. (Hérité de CodeStatement)
LinePragma	Obtient ou définit la ligne sur laquelle l'instruction de code se produit. (Hérité de CodeStatement)
StartDirectives	Obtient un objet CodeDirectiveCollection qui contient des directives de début. (Hérité de CodeStatement)
UserData	Obtient les données définissables par l'utilisateur pour l'objet en cours. (Hérité de CodeObject)

Méthodes

Equals(Object)	Détermine si l'objet spécifié est égal à l'objet actuel. (Hérité de Object)
GetHashCode()	Fait office de fonction de hachage par défaut. (Hérité de Object)
GetType()	Obtient le Type de l'instance actuelle. (Hérité de Object)
MemberwiseClone()	Crée une copie superficielle du Object actuel. (Hérité de Object)
ToString()	Retourne une chaîne qui représente l'objet actuel. (Hérité de Object)

Voir aussi

• CodeComment