CodeFunction.DocComment, propriété

Article
11/15/2012

Obtient ou définit le commentaire du document associé à l'élément du modèle de code en cours.

Espace de noms : EnvDTE
Assembly : EnvDTE (dans EnvDTE.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 représentant le commentaire du document.

Notes

DocComment retourne l'attribut ou le commentaire de documentation particulier s'il en existe un dans le code.Si le langage implémentant le modèle de code ne possède pas de mécanisme de commentaire de documentation ou si aucun n'est associé à l'élément de code, DocComment retourne une chaîne vide.

[!REMARQUE]

Cette propriété est en lecture seule pour les éléments de code provenant du code source Visual Basic.

En outre, 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).

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.