CodeEnum.Comment Property

Definition

Gets or sets the comment associated with the code element.

[System.Runtime.InteropServices.DispId(38)]
[get: System.Runtime.InteropServices.DispId(38)]
[get: System.Runtime.InteropServices.TypeLibFunc(1024)]
[set: System.Runtime.InteropServices.DispId(38)]
[set: System.Runtime.InteropServices.TypeLibFunc(1024)]
public string Comment { get; set; }
Property Value

A string representing the comment associated with the code element.

Remarks

Comment sets or returns the header comment. When returned, the text does not contain comment syntax.

The comment text is derived from the source document that contains the code element. The number of header comment lines collected will vary depending on the language in which the comments are written.

When set, Comment attempts to maintain the style of existing comments by using line-oriented versus delimited syntax, by maintaining any indentation prior to line-oriented syntax, by determining whether the comment touches the code element or is separated by a blank line, and so forth.

Note

The values of code model elements, such as classes, structures, functions, attributes, delegates, cannot be relied upon to remain the same at all times. For more information, see the section Code Model Element Values Can Change in Discovering Code by Using the Code Model (Visual Basic).

Applies to