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

Статья
11/05/2008

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

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

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

Синтаксис

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

Заметки

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

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

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

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

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

Разрешения

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