Właściwość CodeClass2.Comment —

Artykuł
05/17/2015

Ustawia lub pobiera komentarz skojarzony z klasą kodu.

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 reprezentujący komentarz.

Uwagi

CommentUstawia lub zwraca komentarz nagłówka dla tej klasy.Zwrócony tekst nie zawiera żadnych składnia komentarza.Tekst jest pochodną źródło, w oparciu o styl komentarzy języka.Na przykład, w języku C#, ogranicznika komentarza jest / /, ale w języku Visual Basic jest apostrof (') lub Rem (skrót od uwagi).

Po ustawieniu, Comment próby Obsługa stylów wszelkie istniejące komentarze za pomocą liniowym porównaniu rozdzielany składni.W tym procesie określając, czy komentarz dotyka element kodu lub jest oddzielony pusty wiersz utrzymuje wcięcie przed składni w wierszu.

[!UWAGA]

Wartości elementów modelu kodu, takich jak klasy, strukturach, funkcje, atrybuty, delegatów i tak dalej mogą być deterministyczny po dokonaniu niektórych rodzajów modyfikacji, co oznacza, że ich wartości nie mogą być powoływane do zawsze pozostają takie same.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

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

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.