Proprietà CodeClass2.DocComment

Articolo
05/16/2015

Ottiene o imposta il commento del documento per la classe 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 che rappresenta il commento del documento.

Note

La proprietà DocComment restituisce lo speciale attributo o commento relativo alla documentazione se è 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 alla classe di codice non è associato alcun meccanismo di questo tipo, DocComment restituirà una stringa vuota.

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

[C#]

public void CodeClass2DocCommentExample(DTE2 dte2)
{
    // Before running this example, open a code document from a project
    // and place the insertion point within a class definition.
    try
    {   // Get the CodeClass2 at the insertion point.
        TextSelection sel = 
        (TextSelection)dte2.ActiveDocument.Selection;
        CodeClass2 cls = (CodeClass2)sel.ActivePoint.get_CodeElement(
            vsCMElement.vsCMElementClass);

        // Set the document comment for the CodeClass.
        cls.DocComment = "<doc>This is a DocComment\r\n</doc>";

    }
    catch (Exception e)
    {
        Console.WriteLine(e.Message);
    }
}

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.