CodeProperty.Comment, propriété

Article
08/10/2011

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

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

Syntaxe

'Déclaration
Property Comment As String
    Get
    Set

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 représentant le 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 de l'en-tête collecté varie selon le langage dans lequel les commentaires sont écrits.

Si elle est définie, la propriété 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 déterminant si le commentaire touche l'élément de code ou est séparé par une ligne vide, etc.

Notes

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.