Comment-Eigenschaft
Das Dokument wurde archiviert, und die hier aufgeführten Informationen sind möglicherweise veraltet.

CodeType.Comment-Eigenschaft

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

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

string Comment { get; set; }
/** @property */
String get_Comment ()

/** @property */
void set_Comment (String pComment)

function get Comment () : String

function set Comment (pComment : String)

Eigenschaftenwert

Eine Zeichenfolge, die den Kommentar darstellt, der CodeType zugeordnet ist.

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 Sprache, 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. Die Einzüge vor einer zeilenorientierten Syntax werden beibehalten, indem bestimmt wird, ob der Kommentar direkt an das Codeelement anschließt oder durch eine Leerzeile von diesem getrennt ist usw.

NoteHinweis

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

Anzeigen:
© 2016 Microsoft