CodeEvent.Comment, propriété

Article
11/15/2012

Obtient ou définit un commentaire d'en-tête associé à l'élément d'événement de code.

Espace de noms : EnvDTE80
Assembly : EnvDTE80 (dans EnvDTE80.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 : System.String
Chaîne contenant un commentaire d'en-tête, ou une chaîne vide en l'absence de tout commentaire.

Notes

Le texte récupéré ne contient aucune syntaxe de commentaire.Le texte est dérivé de la source, et basé sur le style de commentaire du langage.Par exemple, en langage C#, le délimiteur de commentaire est //, mais en Visual Basic, c'est soit une apostrophe (') soit Rem (pour Remarque).

Lorsqu'elle est définie, la propriété Comment essaie de conserver le style de tout commentaire existant en utilisant une syntaxe orientée ligne plutôt qu'une syntaxe délimitée.Au cours du processus, il conserve toute mise en retrait antérieure à la syntaxe orientée ligne, en déterminant si le commentaire touche l'élément de code ou est séparé par une ligne vide.

[!REMARQUE]

Les valeurs d'éléments de modèle de code, tels que des classes, des structures, des fonctions, des attributs, des délégués, etc., peuvent être non déterminables après certains types de modifications, ce qui signifie qu'il n'est pas certain que leurs valeurs resteront inchangées.Pour plus d'informations, consultez la section Les valeurs d'élément de modèle de code peuvent être modifiées de la rubrique Découverte de code à l'aide du modèle de code (Visual Basic).

Exemples

L'exemple suivant illustre l'utilisation de la propriété Comment.

Pour tester cette propriété :

Ouvrez le projet cible et sélectionnez l'élément d'événement de code en plaçant le curseur sur l'objet événement.
Exécutez le complément.

public static void Comment(EnvDTE80.DTE2 dte)
{
    TextSelection objTextSel;
    EnvDTE80.CodeEvent codeEvent;
    objTextSel = (TextSelection)dte.ActiveDocument.Selection;
    codeEvent = (EnvDTE80.CodeEvent)objTextSel.ActivePoint.get_CodeElement(vsCMElement.vsCMElementEvent);

    MessageBox.Show("\nComment property: " +
                    codeEvent.Comment, "Testing CodeEvent");
}

Sécurité .NET Framework

Confiance totale accordée à l'appelant immédiat. Ce membre ne peut pas être utilisé par du code d'un niveau de confiance partiel. Pour plus d'informations, consultez Utilisation de bibliothèques à partir de code d'un niveau de confiance partiel.