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

Статья
05/17/2015

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

Пространство имен: 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
Строка, представляющая комментарий, связанный с элементом кода.

Заметки

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

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

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

Примечание

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

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

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