Proprietà CodeEvent.DocComment

Articolo
05/16/2015

Ottiene o imposta un commento relativo alla documentazione associato all'elemento di un 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: String
Stringa contenente un commento relativo alla documentazione associato all'elemento di un evento di codice oppure una stringa vuota, se non è disponibile alcun commento.

Note

Viene restituita una stringa vuota se non viene fornito alcun commento o se il linguaggio che implementa il codice non dispone di un meccanismo di questo tipo.

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

Nell'esempio seguente viene illustrato l'utilizzare della proprietà DocComment.

Per verificare la proprietà:

Posizionare il cursore sull'oggetto evento per aprire il progetto di destinazione e selezionare l'elemento di un evento di codice.
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 altre informazioni, vedere Utilizzo di librerie da codice parzialmente attendibile.