Właściwość CodeEvent.Comment —

Artykuł
05/17/2015

Zwraca lub Ustawia komentarz do nagłówka skojarzone z elementem kodu zdarzenia.

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

Składnia

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

Wartość właściwości

Typ: String
Ciąg zawierający komentarz do nagłówka lub pusty ciąg, jeżeli komentarza.

Uwagi

Pobrano tekst nie zawiera żadnych składnia komentarza.Tekst jest pochodną źródło, w oparciu o język, styl komentarzy.Na przykład w języku C#, ogranicznika komentarza jest / /, ale w języku Visual Basic jest apostrof (') albo Rem (Uwaga krótki).

Po ustawieniu, Comment właściwość usiłuje utrzymać styl wszelkie istniejące komentarze za pomocą linii zorientowanych kontra rozdzielany składni.Przy ustalaniu, czy komentarz styka się z elementem kodu lub jest oddzielony od pustego wiersza w procesie, utrzymuje wcięć przed do składni zorientowane na linii.

[!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ć Comment 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 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");
}

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.