Właściwość CodeEvent.DocComment —

Artykuł
05/17/2015

Zwraca lub Ustawia komentarz dokumentacji skojarzone z elementem kodu zdarzenia.

Przestrzeń nazw: EnvDTE80
Zestaw: EnvDTE80 (w EnvDTE80.dll)

Składnia

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

Wartość właściwości

Typ: String
Ciąg zawierający komentarz dokumentacji skojarzone z elementem kodu zdarzenia lub pusty ciąg, jeżeli komentarza.

Uwagi

Pusty ciąg jest zwracany, jeśli komentarza nie jest dostarczone lub język wykonania kodu nie mają mechanizmu komentarz dokumentacji.

[!UWAGA]

Po dokonaniu niektórych rodzajów modyfikacji, co oznacza, że ich wartości nie może polegać na zawsze pozostawać taki sam może być nie deterministyczny wartości elementów modelu kodu, takich jak klasy, strukturach, funkcje, atrybuty, delegatów i tak dalej.Aby uzyskać więcej informacji, zobacz sekcję wartości elementu modelu kod można zmienić w Odnajdowanie kodu za pomocą modelu kodu (Visual Basic).

Przykłady

Poniższy przykład demonstruje, jak używać DocComment właściwości.

Aby przetestować tę właściwość:

Otwórz docelowy projekt i zaznacz element zdarzenia kod umieszczając kursor na obiekcie zdarzenia.
Uruchomienie dodatku.

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

Zabezpieczenia programu .NET Framework

Pełne zaufanie do bezpośredniego wywołującego. Tego elementu członkowskiego nie można używać w kodzie częściowo zaufanym. Aby uzyskać więcej informacji, zobacz Używanie bibliotek pochodzących z częściowo zaufanego kodu.