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

Статья
11/05/2008

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

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

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

Синтаксис

'Декларация
Property DocComment As String
'Применение
Dim instance As CodeClass2
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
Строка, содержащая комментарий к документу.

Реализации

CodeClass.DocComment

Заметки

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

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

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

Примеры

public void CodeClass2DocCommentExample(DTE2 dte2)
{
    // Before running this example, open a code document from a project
    // and place the insertion point within a class definition.
    try
    {   // Get the CodeClass2 at the insertion point.
        TextSelection sel = 
        (TextSelection)dte2.ActiveDocument.Selection;
        CodeClass2 cls = (CodeClass2)sel.ActivePoint.get_CodeElement(
            vsCMElement.vsCMElementClass);

        // Set the document comment for the CodeClass.
        cls.DocComment = "<doc>This is a DocComment\r\n</doc>";

    }
    catch (Exception e)
    {
        Console.WriteLine(e.Message);
    }
}

Разрешения

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