Proprietà CodeEvent.DocComment

Articolo
10/30/2012

Ottiene o imposta un commento relativo alla documentazione associato all'elemento dell'evento di codice.

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

Sintassi

'Dichiarazione
Property DocComment As String

string DocComment { get; set; }

property String^ DocComment {
    String^ get ();
    void set (String^ value);
}

abstract DocComment : string with get, set

function get DocComment () : String
function set DocComment (value : String)

Valore proprietà

Tipo: System.String
Una stringa contenente un commento relativo alla documentazione associato all'elemento dell'evento di codice, o una stringa vuota se nessun comment fornito.

Note

Verrà restituita una stringa vuota se nessun comment viene fornito o se il linguaggio che implementa il codice non include un meccanismo di commento relativo alla documentazione.

[!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 DocComment 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 DocComment(EnvDTE80.DTE2 dte)
{
    TextSelection objTextSel;
    EnvDTE80.CodeEvent codeEvent;
    objTextSel = (TextSelection)dte.ActiveDocument.Selection;
    codeEvent = (EnvDTE80.CodeEvent)objTextSel.ActivePoint.get_CodeElement(vsCMElement.vsCMElementEvent);

    MessageBox.Show("\nDocComment property: " +
                    codeEvent.DocComment, "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.