Proprietà CodeClass.Comment

Articolo
08/11/2011

Ottiene o imposta il commento associato all'oggetto CodeClass.

Spazio dei nomi: EnvDTE
Assembly: EnvDTE (in EnvDTE.dll)

Sintassi

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

Valore proprietà

Tipo: System.String
Stringa che rappresenta i commenti associati all'oggetto CodeClass.

Note

Comment imposta o restituisce il commento di intestazione. Il testo restituito non contiene alcuna sintassi di commento.

Il testo del commento è derivato dal documento di origine contenente l'elemento di codice. Il numero delle righe di commento dell'intestazione raccolte varierà in base alla lingua nella quale i commenti sono scritti.

Quando viene impostata, la proprietà Comment tenta di conservare lo stile dei commenti esistenti utilizzando una sintassi basata sulle righe anziché sui delimitatori, mantenendo ogni rientro impostato prima di tale sintassi e definendo se il commento deve essere unito all'elemento di codice o separato da una riga vuota e così via.

Nota

I valori degli elementi del modello di codice, quali classi, strutture, funzioni, attributi, delegati e così via, possono non essere deterministici dopo alcuni tipi di modifiche. Ciò significa che non si può fare affidamento sulla stabilità di tali valori. Per ulteriori informazioni, vedere la sezione Possibile modifica dei valori degli elementi del modello di codice in Individuazione di codice mediante il modello di codice (Visual Basic).

Esempi

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

Sicurezza di .NET Framework

Attendibilità totale per il chiamante immediato. Impossibile utilizzare questo membro in codice parzialmente attendibile. Per ulteriori informazioni, vedere Utilizzo di librerie da codice parzialmente attendibile.