CodeNamespace.Comment-Eigenschaft

Artikel
08/10/2011

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

Namespace: EnvDTE
Assembly: EnvDTE (in EnvDTE.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
Eine Zeichenfolge, die einen diesem CodeNamespace 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, 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.