Proprietà CodeClass2.DocComment
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: System.String
Stringa che rappresenta il commento del documento.
Note
DocComment la proprietà restituisce il commento relativo alla documentazione l'attributo o speciale se c " viene incluso nella classe di 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 alla classe di codice, quindi DocComment restituisce una stringa vuota.
[!NOTA]
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).
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 ulteriori informazioni, vedere Utilizzo di librerie da codice parzialmente attendibile.
Vedere anche
Riferimenti
Altre risorse
Procedura: compilare ed eseguire gli esempi di codice del modello a oggetti di automazione
Individuazione di codice mediante il modello di codice (Visual Basic)
Individuazione di codice mediante il modello di codice (Visual C#)