CodeClass2.Comment Propriété

Définition

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

public:
 property System::String ^ Comment { System::String ^ get(); void set(System::String ^ value); };
public:
 property Platform::String ^ Comment { Platform::String ^ get(); void set(Platform::String ^ value); };
[System.Runtime.InteropServices.DispId(38)]
public string Comment { [System.Runtime.InteropServices.DispId(38)] [System.Runtime.InteropServices.TypeLibFunc(1024)] get; [System.Runtime.InteropServices.DispId(38)] [System.Runtime.InteropServices.TypeLibFunc(1024)] set; }
[<System.Runtime.InteropServices.DispId(38)>]
[<get: System.Runtime.InteropServices.DispId(38)>]
[<get: System.Runtime.InteropServices.TypeLibFunc(1024)>]
[<set: System.Runtime.InteropServices.DispId(38)>]
[<set: System.Runtime.InteropServices.TypeLibFunc(1024)>]
member this.Comment : string with get, set
Public Property Comment As String

Valeur de propriété

String

Chaîne représentant le commentaire.

Implémente

Attributs

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);  
    }  
}  

Remarques

Comment définit ou retourne le commentaire d’en-tête de la classe. Le texte retourné ne contient pas de syntaxe de commentaire. Le texte est dérivé de la source en fonction du style de commentaire du langage. Par exemple, en C#, le délimiteur de commentaire est//, mais dans Visual Basic, il s’agit d’une apostrophe (') ou d’une valeur REM (Short pour Remark).

Quand elle est définie, Comment tente de maintenir le style d’un commentaire existant en utilisant une syntaxe orientée ligne plutôt que délimitée. Dans le processus, il gère toute mise en retrait avant la syntaxe orientée ligne en déterminant si le commentaire touche l’élément de code ou s’il 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éterministes 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 changer dans la découverte de code à l’aide du modèle de code (Visual Basic).

S’applique à