CodeFunction.DocComment-Eigenschaft

Artikel
08/10/2011

Ruft den Dokumentkommentar für das aktuelle Codemodellelement ab oder legt ihn fest.

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

Syntax

'Declaration
Property DocComment As String
    Get
    Set

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: System.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.

Tipp

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

Außerdem können die Werte von Codemodellelementen wie Klassen, Strukturen, Funktionen, Attributen, Delegaten usw. nach bestimmten Bearbeitungsvorgängen nicht deterministisch sein, d. h., dass nicht mehr davon ausgegangen werden kann, dass ihre Werte immer unverändert bleiben. Weitere Informationen finden Sie im Abschnitt zum Änderungsverhalten von Codemodellelementwerten unter Ermitteln von Code über das Codemodell (Visual Basic).

.NET Framework-Sicherheit

Volle Vertrauenswürdigkeit für den unmittelbaren Aufrufer. Dieser Member kann von nur teilweise vertrauenswürdigem Code nicht verwendet werden. Weitere Informationen finden Sie unter Verwenden von Bibliotheken aus teilweise vertrauenswürdigem Code.