Proprietà CodeEvent.Comment

Articolo
10/30/2012

Ottiene o imposta un commento di intestazione associato all'elemento dell'evento 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
Una stringa contenente un commento di intestazione, o una stringa vuota se nessun comment fornito.

Note

Il testo recuperato 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 la proprietà si tenta di mantenere 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

Nell'esempio seguente viene illustrato come utilizzare Comment proprietà.

Per verificare questa proprietà:

Aprire il progetto di destinazione e selezionare l'elemento dell'evento di codice posizionando il cursore sull'evento.
eseguire il componente aggiuntivo.

public static void Comment(EnvDTE80.DTE2 dte)
{
    TextSelection objTextSel;
    EnvDTE80.CodeEvent codeEvent;
    objTextSel = (TextSelection)dte.ActiveDocument.Selection;
    codeEvent = (EnvDTE80.CodeEvent)objTextSel.ActivePoint.get_CodeElement(vsCMElement.vsCMElementEvent);

    MessageBox.Show("\nComment property: " +
                    codeEvent.Comment, "Testing CodeEvent");
}

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.