Freigeben über


VCCodeBase.Comment-Eigenschaft

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

Namespace:  Microsoft.VisualStudio.VCCodeModel
Assembly:  Microsoft.VisualStudio.VCCodeModel (in Microsoft.VisualStudio.VCCodeModel.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
Ein dem VCCodeBase-Element zugeordneter Kommentar.

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 Kopfzeilenkommentarzeilen variiert abhängig von der Sprache, in der die Kommentare geschrieben werden.

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.

.NET Framework-Sicherheit

Siehe auch

Referenz

VCCodeBase Schnittstelle

Microsoft.VisualStudio.VCCodeModel-Namespace

Weitere Ressourcen

Gewusst wie: Kompilieren und Ausführen der Codebeispiele für das Automatisierungsobjektmodell