Właściwość CodeClass.Comment —

Artykuł
05/17/2015

Zwraca lub Ustawia komentarz, związane z CodeClass obiektu.

Przestrzeń nazw: EnvDTE
Zestaw: EnvDTE (w EnvDTE.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 komentarzy związanych z CodeClass obiektu.

Uwagi

CommentUstawia lub zwraca komentarz nagłówka.Zwracane, tekst nie zawiera żadnych składnia komentarza.

Tekst komentarza pochodzi z dokumentu źródłowego, który zawiera element kodu.Liczba pobrane wiersze komentarza nagłówka różnić w zależności od języka, w którym zostały napisane uwagi.

Po ustawieniu, Comment próbuje zachować styl istniejący komentarz w przy użyciu linii zorientowanych kontra rozdzielany składni, utrzymując wcięcia przed do składni zorientowane na linii, utrzymując czy komentarz styka się z elementem kodu jest oddzielone od pustego wiersza itd.

[!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

Public Sub CodeClassExample(ByVal dte As DTE2) 
    ' Before running this example, open a code document from a
    ' project and place the insertion point inside a class definition.
    Try
        Dim objTextSel As TextSelection
        Dim objCodeCls As CodeClass
        objTextSel = CType(dte.ActiveDocument.Selection, TextSelection)
        objCodeCls = CType(objTextSel.ActivePoint.CodeElement(vsCMElement.vsCMElementClass), CodeClass)
        ' Add comments to CodeClass objCodeClass - notice change in code document.
        objCodeCls.Comment = "Comments for the CodeClass object."
        ' Access top-level object through the CodeClass object
        ' and return the file name of that top-level object.
        MessageBox.Show("Top-level object's filename: " + objCodeCls.DTE.FileName)
        ' Get the language used to code the CodeClass object - returns a GUID.
        MessageBox.Show(objCodeCls.Language)
        ' Get a collection of elements contained by the CodeClass object.
        Dim members As String = "Member Elements of " + objCodeCls.Name + ": " + vbCrLf
        Dim elem As CodeElement
        For Each elem In  objCodeCls.Members
            members = members + (elem.Name + vbCrLf)
        Next elem
        MessageBox.Show(members)
    Catch ex As Exception
        MessageBox.Show(ex.Message)
    End Try
End Sub

public void CodeClassExample(DTE2 dte)
{
   // Before running this example, open a code document from a
   // project and place the insertion point inside a class definition.
   try
   {
      TextSelection objTextSel;
      CodeClass objCodeCls;
      objTextSel = (TextSelection)dte.ActiveDocument.Selection;
      objCodeCls = (CodeClass)objTextSel.ActivePoint.get_CodeElement(vsCMElement.vsCMElementClass);
      // Add comments to CodeClass objCodeClass - notice change in code document.
      objCodeCls.Comment = "Comments for the CodeClass object.";
      // Access top-level object through the CodeClass object
      // and return the filename of that top-level object.
      MessageBox.Show("Top-level object's filename: " + objCodeCls.DTE.FileName);
      // Get the language used to code the CodeClass object - returns a GUID.
      MessageBox.Show(objCodeCls.Language);
      // Get a collection of elements contained by the CodeClass object.
      string members = "Member Elements of " + objCodeCls.Name + ": \n";
      foreach (CodeElement elem in objCodeCls.Members)
      {
         members = members + (elem.Name + "\n");
      }
      MessageBox.Show(members);
   }
   catch (Exception ex)
   {
      MessageBox.Show(ex.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.