CodeClass2.DocComment – vlastnost

Článek
10/27/2012

Získá nebo Nastaví komentář pro kód třídy dokumentu.

Obor názvů: EnvDTE80
Sestavení: EnvDTE80 (v EnvDTE80.dll)

Syntaxe

'Deklarace
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)

Hodnota vlastnosti

Typ: System.String
Řetězec představující dokumentu komentáře.

Poznámky

DocComment Vlastnost vrací komentář zvláštní dokumentace nebo atribut, pokud je kód třídy.Pokud jazyk implementace modelu kódu nemá mechanismus komentář dokumentaci nebo pokud není žádný přidružený kód třídy, pak DocComment vrátí prázdný řetězec.

[!POZNÁMKA]

Není deterministický může být po provedení určité typy úprav, což znamená, že jejich hodnoty nelze dovolávat vždy zůstat stejné hodnoty prvků modelu kód jako třídy, struktury, funkce, atributy, delegátů a tak dále.Další informace naleznete v části Změna hodnoty prvku modelu kódu Zjištění kódu pomocí kódu modelu (Visual Basic).

Příklady

[C#]

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);
    }
}

Zabezpečení rozhraní .NET Framework

Plná důvěra přímému volajícímu. Částečně zabezpečený kód nemůže tento člen použít. Další informace naleznete v tématu Používání knihoven z částečně důvěryhodného kódu.