Proprietà CodeVariable.DocComment

Articolo
08/11/2011

Ottiene o imposta il commento del documento per l'elemento del modello di codice corrente.

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

Sintassi

'Dichiarazione
Property DocComment As String
    Get
    Set

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
Stringa che rappresenta il commento del documento.

Note

La proprietà DocComment restituisce l'attributo o il commento speciale relativo alla documentazione eventualmente presente nel codice. Se il linguaggio che implementa il modello di codice non dispone di un meccanismo per la creazione di commenti relativi alla documentazione o se all'elemento di codice non è associato alcun meccanismo di questo tipo, DocComment restituirà una stringa vuota.

Nota

La proprietà è in sola lettura per gli elementi del codice sorgente di Visual Basic.

Inoltre, 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).

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.