CodeEvent.DocComment, propriété

Article
11/15/2012

Obtient ou définit un commentaire de documentation associé à l'élément d'événement de code.

Espace de noms : EnvDTE80
Assembly : EnvDTE80 (dans EnvDTE80.dll)

Syntaxe

'Déclaration
Property DocComment As String

string DocComment { get; set; }

property String^ DocComment {
    String^ get ();
    void set (String^ value);
}

abstract DocComment : string with get, set

function get DocComment () : String
function set DocComment (value : String)

Valeur de propriété

Type : System.String
Chaîne contenant un commentaire de documentation associé à l'élément d'événement de code, ou une chaîne vide, en l'absence de tout commentaire.

Notes

Une chaîne vide est retournée si aucun commentaire n'est fourni ou si le langage d'implémentation du code ne dispose pas de mécanisme de commentaire de documentation.

[!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é DocComment.

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 DocComment(EnvDTE80.DTE2 dte)
{
    TextSelection objTextSel;
    EnvDTE80.CodeEvent codeEvent;
    objTextSel = (TextSelection)dte.ActiveDocument.Selection;
    codeEvent = (EnvDTE80.CodeEvent)objTextSel.ActivePoint.get_CodeElement(vsCMElement.vsCMElementEvent);

    MessageBox.Show("\nDocComment property: " +
                    codeEvent.DocComment, "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.