VCCodeVariable.Comment - свойство

Статья
10/16/2008

Gets or sets the comment associated with the code element.

Пространство имен: Microsoft.VisualStudio.VCCodeModel
Сборка: Microsoft.VisualStudio.VCCodeModel (в Microsoft.VisualStudio.VCCodeModel.dll)

Синтаксис

'Декларация
Property Comment As String
'Применение
Dim instance As VCCodeVariable
Dim value As String

value = instance.Comment

instance.Comment = value

string Comment { get; set; }

property String^ Comment {
    String^ get ();
    void set (String^ value);
}

function get Comment () : String
function set Comment (value : String)

Значение свойства

Тип: System.String

The comment associated with the code element.

Заметки

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.

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.

Разрешения

Полное доверие для непосредственно вызывающего метода. Этот член не может быть использован частично доверенным кодом. Дополнительные сведения см. в разделе Using Libraries from Partially Trusted Code.