Partager via


VCCodeBase.Comment, propriété

Obtient ou définit le commentaire associé à l'élément de code.

Espace de noms :  Microsoft.VisualStudio.VCCodeModel
Assembly :  Microsoft.VisualStudio.VCCodeModel (dans Microsoft.VisualStudio.VCCodeModel.dll)

Syntaxe

'Déclaration
Property Comment As String
string Comment { get; set; }
property String^ Comment {
    String^ get ();
    void set (String^ value);
}
abstract Comment : string with get, set
function get Comment () : String 
function set Comment (value : String)

Valeur de propriété

Type : String
Commentaire associé à l'élément VCCodeBase.

Notes

Comment définit ou retourne le commentaire de l'en-tête. Lorsqu'il est retourné, le texte ne contient aucune syntaxe de commentaire. Le texte du commentaire est dérivé du document source qui contient l'élément de code. Le nombre de lignes des commentaires d'en-tête collectées varie selon le langage dans lequel les commentaires sont écrits.

Lorsqu'il est défini, Comment tente de préserver le style de n'importe quel commentaire existant en utilisant une syntaxe orientée ligne, plutôt que délimitée, en conservant la mise en retrait préalable à la syntaxe orientée ligne, en respectant le fait que le commentaire touche l'élément de code ou est séparé par une ligne vide, etc.

Sécurité .NET Framework

Voir aussi

Référence

VCCodeBase Interface

Microsoft.VisualStudio.VCCodeModel, espace de noms

Autres ressources

Comment : compiler et exécuter les exemples de code du modèle objet Automation