Proprietà CodeClass2.Comment

Articolo
08/11/2011

Imposta o ottiene il commento associato alla classe di codice.

Spazio dei nomi: EnvDTE80
Assembly: EnvDTE80 (in EnvDTE80.dll)

Sintassi

'Dichiarazione
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)

Valore proprietà

Tipo: System.String
Stringa che rappresenta il commento.

Implementa

CodeClass.Comment

Note

La proprietà Comment imposta o restituisce il commento di intestazione per la classe. Il testo restituito non contiene alcuna sintassi di commento. Il testo deriva dalla sorgente in base allo stile dei commenti del linguaggio. Ad esempio, in C# il delimitatore di commento è //, ma in Visual Basic è un apostrofo (') o Rem (abbreviazione di remark).

Se impostata, la proprietà Comment tenta di mantenere lo stile dei commenti esistenti utilizzando la sintassi basata sulle righe anziché quella basata sui delimitatori. Nel processo, mantiene i rientri prima della sintassi basata sulle righe determinando se il commento è adiacente all'elemento di codice o è separato da una riga vuota.

Nota

I valori degli elementi del modello di codice, quali classi, strutture, funzioni, attributi, delegati e così via, possono non essere deterministici dopo alcuni tipi di modifiche. Ciò significa che non si può fare affidamento sulla stabilità di tali valori. Per ulteriori informazioni, vedere la sezione Possibile modifica dei valori degli elementi del modello di codice in Individuazione di codice mediante il modello di codice (Visual Basic).

Esempi

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

Sicurezza di .NET Framework

Attendibilità totale per il chiamante immediato. Impossibile utilizzare questo membro in codice parzialmente attendibile. Per ulteriori informazioni, vedere Utilizzo di librerie da codice parzialmente attendibile.