CodeEvent.Comment – vlastnost

Článek
08/11/2011

Získá nebo nastaví záhlaví poznámky spojené s událostí prvek kódu.

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

Syntaxe

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

Hodnota vlastnosti

Typ: System.String
Řetězec obsahující záhlaví poznámky nebo prázdný řetězec, není-li žádná poznámka.

Poznámky

Načtená text neobsahuje žádné komentáře syntaxe. Text je odvozen ze zdroje založené na jazyce Styl komentáře. Například v jazyce C# je oddělovačem komentáře / /, ale v jazyce Visual Basic je apostrof (') nebo Rem (zkratka pro příspěvek).

Je-li nastavena Comment vlastnost se pokusí zachovat styl všechny existující poznámky pomocí řádkový versus oddělovači syntaxe. V procesu udržuje jakékoliv odsazení před na syntaxi řádkový určením, zda komentář dotýká prvek kódu nebo odděleny prázdným řádkem.

Poznámka

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 Discovering Code by Using the Code Model (Visual Basic).

Příklady

Následující příklad demonstruje použití Comment 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 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");
}

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.