CodeComment Classe

Définition

Espace de noms:

System.CodeDom

Assembly:

System.CodeDom.dll

Paquet:

System.CodeDom v8.0.0

Source:

CodeComment.cs

Représente un commentaire.

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

public class CodeComment : System.CodeDom.CodeObject

type CodeComment = class
    inherit CodeObject

Public Class CodeComment
Inherits CodeObject

Héritage

Object

CodeObject

CodeComment

Exemples

Cet exemple illustre l’utilisation d’un CodeComment 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

CodeCommentpeut être utilisé pour représenter une seule commentaire de ligne.

Un CodeCommentStatement peut contenir un CodeComment et lui permet d’être traité comme une instruction et généré en tant que code au sein d’une collection d’instructions. Les commentaires multilignes peuvent être représentés avec plusieurs CodeCommentStatement objets.

Pour inclure un commentaire dans un graphe CodeDOM qui peut être généré dans le code source, ajoutez un CodeComment à un CodeCommentStatement, puis ajoutez-le à la collection d’instructions d’un CodeMemberMethod ou à la collection de commentaires d’un CodeNamespace objet ou tout objet dérivé de CodeTypeMember.

Constructeurs

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

Propriétés

DocComment	Obtient ou définit une valeur qui indique si le commentaire est un commentaire de la documentation.
Text	Obtient ou définit le texte du commentaire.
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

• CodeCommentStatement
• Comments