VCCodeInterface.Comment 属性

定义

获取或设置与代码元素关联的注释。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

属性值

String

与代码元素关联的注释。The comment associated with the code element.

属性

注解

Comment 设置或返回标题注释。Comment sets or returns the header comment. 返回时,文本不包含任何注释语法。When returned, the text does not contain any comment syntax. 注释文本派生自包含代码元素的源文档。The comment text is derived from the source document that contains the code element. 收集的标头注释行的数目因编写注释所采用的语言而异。The number of header comment lines collected varies depending on the language in which the comments are written.

如果设置此参数,则将 Comment 尝试通过使用面向行的语法和带分隔符的语法来维护任何现有注释的样式,方法是通过维护注释是否涉及代码元素或用空行分隔,等等。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.

适用于