CodeVariable2.Comment-Eigenschaft

Artikel
08/10/2011

Ruft den dem Codeelement zugeordneten Kommentar ab oder legt diesen fest.

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

Syntax

'Declaration
Property Comment As String
    Get
    Set

string Comment { get; set; }

property String^ Comment {
    String^ get ();
    void set (String^ value);
}

abstract Comment : string with get, set

function get Comment () : String
function set Comment (value : String)

Eigenschaftswert

Typ: System.String
Der dem Codeelement zugeordnete Kommentar.

Implementiert

CodeVariable.Comment

Hinweise

Comment legt den Headerkommentar fest oder gibt ihn zurück. Der zurückgegebene Text enthält keine Kommentarsyntax. Der Text wird auf Grundlage vom Kommentarformat der Sprache von der Quelle abgeleitet.

Wenn festgelegt, versucht Comment, den Stil von bereits vorhandenen Kommentaren beizubehalten. Hierzu wird eine zeilenorientierte anstelle einer getrennten Syntax verwendet, wobei alle Einzüge vor einer zeilenorientierten Syntax beibehalten werden. Außerdem wird bestimmt, ob der Kommentar direkt an das Codeelement anschließt oder durch eine Leerzeile von diesem getrennt ist, usw.

Tipp

Die Werte von Codemodellelementen wie Klassen, Strukturen, Funktionen, Attributen, Delegaten usw. können 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.