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

Статья
08/11/2011

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

Пространство имен: EnvDTE80
Сборка: EnvDTE80 (в EnvDTE80.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
Строка, содержащая комментарий к документу.

Реализации

CodeVariable.DocComment

Заметки

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

Примечание

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

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

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

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