VCCodeInterface.Comment Eigenschaft

Definition

Ruft den zum Codeelement zugeordneten Kommentar ab oder legt diesen fest.Gets or sets the comment associated with the code element.

public:
 property System::String ^ Comment { System::String ^ get(); void set(System::String ^ value); };
public:
 property Platform::String ^ Comment { Platform::String ^ get(); void set(Platform::String ^ value); };
[System.Runtime.InteropServices.DispId(38)]
[get: System.Runtime.InteropServices.DispId(38)]
[get: System.Runtime.InteropServices.TypeLibFunc(System.Runtime.InteropServices.TypeLibFuncFlags.FNonBrowsable)]
[set: System.Runtime.InteropServices.DispId(38)]
[set: System.Runtime.InteropServices.TypeLibFunc(System.Runtime.InteropServices.TypeLibFuncFlags.FNonBrowsable)]
public string Comment { get; set; }
[<System.Runtime.InteropServices.DispId(38)>]
[<get: System.Runtime.InteropServices.DispId(38)>]
[<get: System.Runtime.InteropServices.TypeLibFunc(System.Runtime.InteropServices.TypeLibFuncFlags.FNonBrowsable)>]
[<set: System.Runtime.InteropServices.DispId(38)>]
[<set: System.Runtime.InteropServices.TypeLibFunc(System.Runtime.InteropServices.TypeLibFuncFlags.FNonBrowsable)>]
member this.Comment : string with get, set
Public Property Comment As String

Eigenschaftswert

String

Der dem Codeelement zugeordnete Kommentar.The comment associated with the code element.

Attribute

Hinweise

Comment Legt den Header Kommentar fest oder gibt ihn zurück.Comment sets or returns the header comment. Wenn der Text zurückgegeben wird, enthält er keine Kommentar Syntax.When returned, the text does not contain any comment syntax. Der Kommentartext wird aus dem Quelldokument abgeleitet, das das Code Element enthält.The comment text is derived from the source document that contains the code element. Die Anzahl der gesammelten Header Kommentarzeilen variiert abhängig von der Sprache, in der die Kommentare geschrieben werden.The number of header comment lines collected varies depending on the language in which the comments are written.

Wenn diese Einstellung festgelegt ist, wird Comment versucht, den Stil eines vorhandenen Kommentars mithilfe der zeilenorientierten und der durch Trennzeichen getrennten Syntax beizubehalten, indem jeder Einzug vor der zeilenorientierten Syntax beibehalten wird, indem beibehalten wird, ob der Kommentar das Code Element berührt oder durch eine leere Zeile getrennt ist usw.When set, Comment attempts to maintain the style of any existing comment by using line-oriented versus delimited syntax, by maintaining any indentation prior to line-oriented syntax, by maintaining whether the comment touches the code element or is separated by a blank line, and so forth.

Gilt für: