Proprietà CodeVariable.DocComment

Articolo
10/30/2012

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

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

DocComment restituisce il commento relativo alla documentazione l'attributo o speciale se c " è uno nel codice.Se il linguaggio che implementa il modello di codice non include un meccanismo di commento relativo alla documentazione, o se non sono indicati sono associati all'elemento di codice, quindi DocComment restituisce una stringa vuota.

[!NOTA]

Questa proprietà è di sola lettura per gli elementi di codice dal codice sorgente di Visual Basic.

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

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.