CodeInterface.DocComment Eigenschaft

Definition

Ruft den zum aktuellen Codemodellelement zugeordneten Dokumentkommentar ab oder legt diesen fest.

public:
 property System::String ^ DocComment { System::String ^ get(); void set(System::String ^ value); };
public:
 property Platform::String ^ DocComment { Platform::String ^ get(); void set(Platform::String ^ value); };
[System.Runtime.InteropServices.DispId(37)]
public string DocComment { [System.Runtime.InteropServices.DispId(37)] [System.Runtime.InteropServices.TypeLibFunc(1024)] get; [System.Runtime.InteropServices.DispId(37)] [System.Runtime.InteropServices.TypeLibFunc(1024)] set; }
[<System.Runtime.InteropServices.DispId(37)>]
[<get: System.Runtime.InteropServices.DispId(37)>]
[<get: System.Runtime.InteropServices.TypeLibFunc(1024)>]
[<set: System.Runtime.InteropServices.DispId(37)>]
[<set: System.Runtime.InteropServices.TypeLibFunc(1024)>]
member this.DocComment : string with get, set
Public Property DocComment As String

Eigenschaftswert

String

Eine Zeichenfolge, die den Dokumentkommentar darstellt.

Attribute

Hinweise

DocComment Gibt den speziellen Dokumentations Kommentar oder das Attribut zurück, wenn ein Code im Code vorhanden ist. Wenn die Sprache, die das Code Modell implementiert, nicht über einen Dokumentations Kommentar Mechanismus verfügt, oder wenn keine dem Code Element zugeordneten Sprache vorhanden ist, wird DocComment eine leere Zeichenfolge zurückgegeben.

Hinweis

Diese Eigenschaft ist für Code Elemente aus Visual Basic Quellcode schreibgeschützt.

Außerdem können die Werte von Code Modellelementen, wie z. b. Klassen, Strukturen, Funktionen, Attribute, Delegaten usw., nicht deterministisch sein, nachdem bestimmte Arten von Änderungen vorgenommen wurden. Dies bedeutet, dass ihre Werte nicht immer gleich bleiben. Weitere Informationen finden Sie im Abschnitt Code Modell Element-Werte können sich in ermitteln von Code mithilfe des Code Modells (Visual Basic)ändern.

Gilt für