CodeClass.Comment – vlastnost

Článek
08/11/2011

Získá nebo nastaví komentáře přidružené CodeClass objektu.

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

Syntaxe

'Deklarace
Property Comment As String
    Get
    Set

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)

Hodnota vlastnosti

Typ: System.String
Řetězec představující komentáře přidružené CodeClass objektu.

Poznámky

CommentNastaví nebo vrátí hlavičku poznámka. Při vrácení text neobsahuje žádné komentáře syntaxe.

Text poznámky je odvozen ze zdrojového dokumentu, který obsahuje prvek kódu. Počet řádků záhlaví komentář shromážděné bude záviset na jazyk, ve kterém jsou zapsány komentáře.

Při nastavení Comment se pokusí zachovat styl všechny existující poznámky pomocí řádkový versus oddělovači syntaxe udržováním odsazení před k syntaxi řádkový udržováním zda komentář dotýká prvek kódu nebo oddělené prázdný řádek a tak dále.

Poznámka

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

Příklady

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

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.