CodeEvent.DocComment – vlastnost

Článek
10/27/2012

Získá nebo Nastaví komentář dokumentaci související s událostí prvek kódu.

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 obsahující komentář dokumentaci související s událostí prvek kódu nebo prázdný řetězec, pokud je k dispozici žádná poznámka.

Poznámky

Prázdný řetězec bude vrácena, pokud je k dispozici žádná poznámka nebo nemá-li provádění kódu jazyka mechanismus komentář dokumentaci.

[!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

Následující příklad demonstruje použití DocComment vlastnost.

Tato vlastnost testování:

Otevřete cílový projekt a vyberte prvek kódu události umístěním kurzoru na objektu události.
Spusťte doplněk.

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

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

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.