Partager via


VCCodeFunction.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 de code.

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 de commentaires d'en-tête collectées varie selon la langue dans laquelle les commentaires sont enregistrés.

Une fois la propriété définie, tente d'Comment de conserver le style d'un commentaire existant à l'aide de au niveau de la ligne par rapport à la syntaxe délimitée, en conservant une mise en retrait avant la syntaxe orienté ligne, en la maintenant si 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

VCCodeFunction Interface

Microsoft.VisualStudio.VCCodeModel, espace de noms

Autres ressources

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