Proprietà CodeStruct.Comment

Articolo
08/11/2011

Ottiene o imposta il commento associato a CodeStruct.

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

Sintassi

'Dichiarazione
Property Comment As String
    Get
    Set

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 che rappresenta il commento associato a CodeStruct.

Note

Comment imposta o restituisce il commento di intestazione. Il testo restituito non contiene sintassi di commento.

Il testo del commento è derivato dal documento di origine contenente l'elemento di codice. Il numero delle righe di commento dell'intestazione raccolte varierà in base alla lingua nella quale i commenti sono scritti.

Quando viene impostata, la proprietà Comment tenta di conservare lo stile dei commenti esistenti utilizzando una sintassi basata sulle righe anziché sui delimitatori, mantenendo ogni rientro impostato prima di tale sintassi e determinando se il commento deve essere unito all'elemento di codice o separato da una riga vuota e così via.

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

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.