CodeDelegate.Comment-Eigenschaft

Artikel
05/16/2015

Ruft den Kommentar ab, der CodeDelegate zugeordnet ist, oder legt ihn fest.

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

Syntax

'Declaration
Property Comment As String

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: String
Eine Zeichenfolge mit den Kommentaren, die CodeDelegate zugeordnet sind.

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 bereits vorhandener Kommentare beizubehalten. Hierzu wird anstelle einer getrennten eine zeilenorientierte Syntax verwendet. Durch Comment werden beispielsweise Einzüge vor der zeilenorientierten Syntax beibehalten und bestimmt, ob der Kommentar direkt an das Codeelement anschließt oder durch eine Leerzeile von diesem getrennt ist, 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).

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