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

Статья
11/05/2008

Обновлен: Ноябрь 2007

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

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

Синтаксис

'Декларация
Property DocComment As String
'Применение
Dim instance As CodeFunction
Dim value As String

value = instance.DocComment

instance.DocComment = value

string DocComment { get; set; }

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

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

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

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

Заметки

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

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

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

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

Разрешения

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