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

Статья
05/17/2015

Получает или задает комментарий, связанный с объектом CodeNamespace.

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

Синтаксис

'Декларация
Property Comment As String

string Comment { get; set; }

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

abstract Comment : string with get, set

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

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

Тип: String
Строка, представляющая комментарий, связанный с CodeNamespace.

Заметки

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

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

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

Примечание

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

Безопасность платформы .NET Framework

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