CodeClass2.Comment – vlastnost

Článek
05/16/2015

Nastaví nebo získá poznámky spojené s třídou kódu.

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

Syntaxe

'Deklarace
Property Comment As String

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: String
Řetězec představující komentář.

Poznámky

CommentNastaví nebo vrátí komentář záhlaví třídy.Vrácený text neobsahuje žádné syntaxe komentáře.Text je odvozen ze zdroje založené na styl komentáře na jazyk.Například v jazyce C# je oddělovačem komentářů / /, ale v jazyce Visual Basic je apostrof (') nebo Rem (zkratka pro příspěvek).

Je-li nastaveno, Comment pokusí zachovat styl všechny existující poznámky pomocí řádkový versus s 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 jsou odděleny prázdným řádkem.

[!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 prvků modelu kód Zjišťování kódu pomocí modelu kódu (Visual Basic).

Příklady

[C#]

public void CodeClass2CommentExample(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 header comment for the CodeClass.
        cls.Comment = "Comment added programmatically.";
    }
    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.