CodeFunction.Comment-Eigenschaft

Artikel
08/23/2008

Aktualisiert: November 2007

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

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

Syntax

Property Comment As String

Dim instance As CodeFunction
Dim value As String

value = instance.Comment

instance.Comment = value

string Comment { get; set; }

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

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

Eigenschaftenwert

Typ: System.String

Eine Zeichenfolge, die den dem Codeelement zugeordneten Kommentar darstellt.

Hinweise

Comment legt den Headerkommentar fest oder gibt ihn zurück. Der zurückgegebene Text enthält keine Kommentarsyntax.

Der Kommentartext wird vom Quelldokument abgeleitet, das das Codeelement enthält. Die Anzahl der erfassten Headerkommentarzeilen ist je nach der Programmiersprache, in der die Kommentare geschrieben werden, unterschiedlich.

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

Hinweis:
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).

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).

Berechtigungen

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.