CodeClass2.Comment, propriété

Article
08/10/2011

Obtient ou définit le commentaire associé à la classe de code.

Espace de noms : EnvDTE80
Assembly : EnvDTE80 (dans EnvDTE80.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.

Implémentations

CodeClass.Comment

Notes

Comment définit ou retourne le commentaire de l'en-tête de la classe. Le texte retourné 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, 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.

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).

Exemples

[C#]

public void CodeClass2CommentExample(DTE2 dte2)
{
    // Before running this example, open a code document from a project
    // and place the insertion point within a class definition.
    try
    {   // Get the CodeClass2 at the insertion point.
        TextSelection sel = 
        (TextSelection)dte2.ActiveDocument.Selection;
        CodeClass2 cls = (CodeClass2)sel.ActivePoint.get_CodeElement(
            vsCMElement.vsCMElementClass);

        // Set the header comment for the CodeClass.
        cls.Comment = "Comment added programmatically.";
    }
    catch (Exception e)
    {
        Console.WriteLine(e.Message);
    }
}

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.