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

Статья
05/17/2015

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

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

Синтаксис

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

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)

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

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

Заметки

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

Примечание

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

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

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