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

Статья
11/05/2008

Обновлен: Ноябрь 2007

Возвращает или задает комментарий, связанный с CodeStruct.

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

Синтаксис

'Декларация
Property Comment As String
'Применение
Dim instance As CodeStruct
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
Строка, представляющая комментарий, связанный с CodeStruct.

Заметки

Comment задает или возвращает комментарий к заголовку. Возвращаемый текст не содержит синтаксических элементов комментария.

Текст комментария берется из исходного документа, содержащего данный элемент кода. Число собранных строк комментариев к заголовку зависит от языка, на котором написаны комментарии.

При задании свойства Comment делается попытка сохранить стиль существующих комментариев за счет использования синтаксиса строк вместо синтаксиса с разделителями, за счет сохранения любых отступов в синтаксисе строк, а также за счет контактного расположения комментариев и элементов кода и расположения с разделением через пустую строку и с помощью других средств.

Примечание.
Значения элементов модели кода, таких как классы, структуры, функции, атрибуты, делегаты и другие, после внесения некоторых изменений могут оказаться недетерминированными, другими словами, нельзя рассчитывать, что их значения будут всегда оставаться одинаковыми. Дополнительные сведения см. в разделе "Значения элементов модели кода могут изменяться" раздела Практическое руководство. Поиск кода при помощи модели кода (Visual Basic).

Значения элементов модели кода, таких как классы, структуры, функции, атрибуты, делегаты и другие, после внесения некоторых изменений могут оказаться недетерминированными, другими словами, нельзя рассчитывать, что их значения будут всегда оставаться одинаковыми. Дополнительные сведения см. в разделе "Значения элементов модели кода могут изменяться" раздела Практическое руководство. Поиск кода при помощи модели кода (Visual Basic).

Разрешения

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