CodeInterface2.Comment-Eigenschaft

Artikel
05/16/2015

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

Namespace: EnvDTE80
Assembly: EnvDTE80 (in EnvDTE80.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
Der dem Codeelement zugeordnete Kommentar.

Hinweise

Comment legt den Headerkommentar fest oder gibt ihn zurück. Der zurückgegebene Text enthält keine Kommentarsyntax. Der Text wird von der Quelle anhand des Kommentarstils der Sprache abgeleitet. Dies geschieht in Bezug darauf, wie weit die Quellen zum Abrufen von Kommentaren durchsucht werden, um den Headerkommentar für ein Codeelement zu ermitteln.

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

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