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

Статья
08/11/2011

Возвращает комментарий документа для элемента CodeEnum.

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

Синтаксис

'Декларация
Property DocComment As String
    Get
    Set

string DocComment { get; set; }

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

abstract DocComment : string with get, set

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

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

Тип: System.String
Строка, содержащая комментарий документа.

Заметки

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

Для элементов исходного кода Visual Basic .NET это свойство доступно только для чтения.

Примечание

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

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

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