Proprietà CodeClass2.Comment

Articolo
10/30/2012

Gli ottiene o imposta il commento associato alla classe di codice.

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

Sintassi

'Dichiarazione
Property Comment As String

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.

Note

Comment imposta o restituisce il commento dell'intestazione della classe.Il testo restituito non contiene sintassi di commento.Il testo viene derivato dal database di origine in base allo stile del commento del linguaggio.Ad esempio, in c#, il delimitatore di commento è //, ma in Visual Basic, è un apostrofo (') o rem (abbreviazione per il commento).

una volta impostato, Comment tentativi di gestire lo stile di qualsiasi commento esistente utilizzando riga orientata alla sintassi delimitata.Nel processo, gestisce tutto il rientro prima di sintassi basata sulle righe determinando se il commento tocca l'elemento di codice o è separato da una riga vuota.

[!NOTA]

I valori degli elementi del modello di codice come classi, strutture, le funzioni, gli attributi, delegati, e così via possono non essere deterministici dopo l'inserimento di determinati tipi di modifiche, pertanto i relativi valori non possono essere basati su per rimanere sempre gli stessi.Per ulteriori informazioni, vedere i valori degli elementi del modello di codice della sezione può cambiare 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.