Freigeben über


VCCodeEnum.DocComment-Eigenschaft

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

Namespace:  Microsoft.VisualStudio.VCCodeModel
Assembly:  Microsoft.VisualStudio.VCCodeModel (in Microsoft.VisualStudio.VCCodeModel.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: System.String
Der Dokumentkommentar für das aktuelle Codemodellelement.

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.

HinweisHinweis

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

.NET Framework-Sicherheit

Siehe auch

Referenz

VCCodeEnum Schnittstelle

Microsoft.VisualStudio.VCCodeModel-Namespace