CodeFunction.DocComment – vlastnost

Článek
08/11/2011

Získá nebo Nastaví komentář pro aktuální prvek modelu kód dokumentu.

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

Syntaxe

'Deklarace
Property DocComment As String
    Get
    Set

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

DocCommentPokud je kód vrátí komentář zvláštní dokumentace nebo atribut. Implementace modelu kódu jazyka nemá mechanismus komentář dokumentaci nebo pokud není žádný prvek kódu pak přidružené DocComment vrátí prázdný řetězec.

Poznámka

Tato vlastnost je jen pro čtení pro prvky kódu ze zdrojového kódu jazyka Visual Basic.

Hodnoty prvků modelu kód jako třídy, struktury, funkce, atributy, delegátů a tak dále mohou být také-deterministický po provedení určité typy úprav, což znamená, že jejich hodnoty nelze dovolávat vždy zůstává stejné. Další informace naleznete v části Změna hodnoty prvku modelu kódu Discovering Code by Using the Code Model (Visual Basic).

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.