Freigeben über


CodeEnum.DocComment-Eigenschaft

Ruft den Dokumentkommentar für das CodeEnum-Element ab.

Namespace:  EnvDTE
Assembly:  EnvDTE (in EnvDTE.dll)

Syntax

'Declaration
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)

Eigenschaftswert

Typ: String
Eine Zeichenfolge, die den Dokumentkommentar darstellt.

Hinweise

DocComment gibt den ggf. im Code vorhandenen speziellen Dokumentationskommentar oder das Dokumentationsattribut zurück. Wenn die Programmiersprache, durch die das Codemodell implementiert wird, nicht über einen Mechanismus für Dokumentationskommentare verfügt oder dem Codeelement kein Kommentar zugeordnet ist, gibt DocComment eine leere Zeichenfolge zurück.

Diese Eigenschaft ist für Codeelemente aus Visual Basic-Quellcode schreibgeschützt.

Hinweis

Bei den Werten von Codemodellelementen, z. B. Klassen, Strukturen, Funktionen, Attribute, Delegate, kann nicht davon ausgegangen werden, dass sie jederzeit gleich bleiben.Weitere Informationen finden Sie im Abschnitt zum Änderungsverhalten von Codemodellelementwerten unter Ermitteln von Code über das Codemodell (Visual Basic).

.NET Framework-Sicherheit

Siehe auch

Referenz

CodeEnum Schnittstelle

EnvDTE-Namespace

Weitere Ressourcen

Gewusst wie: Kompilieren und Ausführen der Codebeispiele für das Automatisierungsobjektmodell

Ermitteln von Code über das Codemodell (Visual Basic)

Ermitteln von Code über das Codemodell (Visual C#)