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

Статья
08/11/2011

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

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

Синтаксис

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

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)

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

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

Заметки

Возвращаемый текст не содержит синтаксиса комментария. Текст извлекается из источника с учетом стиля оформления комментариев, принятого в языке. Например в C#, разделителем комментария является //, но в Visual Basic разделителем комментария является либо апостроф ('), либо Rem (сокращение для заметки).

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

Примечание

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

Примеры

В следующем примере демонстрируется применение свойства Comment.

Чтобы проверить это свойство, выполните следующие действия.

Откройте проект и выберите элемент кода события, установив текстовый курсор в объект события.
Запустите надстройку.

public static void Comment(EnvDTE80.DTE2 dte)
{
    TextSelection objTextSel;
    EnvDTE80.CodeEvent codeEvent;
    objTextSel = (TextSelection)dte.ActiveDocument.Selection;
    codeEvent = (EnvDTE80.CodeEvent)objTextSel.ActivePoint.get_CodeElement(vsCMElement.vsCMElementEvent);

    MessageBox.Show("\nComment property: " +
                    codeEvent.Comment, "Testing CodeEvent");
}

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

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