Propriedade CodeClass.Comment

Artigo
08/01/2011

Obtém ou define o comentário associado a CodeClass objeto.

Namespace: EnvDTE
Assembly: EnvDTE (em EnvDTE.dll)

Sintaxe

'Declaração
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)

Valor de propriedade

Tipo: System.String
Uma seqüência de caracteres que representa os comentários associados a CodeClass objeto.

Comentários

CommentDefine ou retorna o comentário do cabeçalho. Quando retornado, o texto não contém qualquer sintaxe de comentário.

O texto do comentário é derivado do documento de origem que contém o elemento de código. O número de linhas de comentário do cabeçalho coletados irão variar dependendo do idioma no qual os comentários são gravados.

Quando definido, Comment tenta manter o estilo de qualquer comentário existente usando o orientado por linhas versus sintaxe delimitado, mantendo o recuo antes para sintaxe orientado por linhas, mantendo-se se o comentário toca o elemento de código ou é separado por uma linha em branco e assim por diante.

Observação
Os valores dos elementos de modelo de código como classes, estruturas, funções, atributos, delegados e assim por diante podem ser não-determinísticos depois de fazer determinados tipos de edições, o que significa que seus valores não confie sempre permanecer o mesmo. Para obter mais informações, consulte a seção valores de elemento de modelo de código podem ser alteradas nas Descobrindo o Código usando o modelo de Código (Visual Basic).

Os valores dos elementos de modelo de código como classes, estruturas, funções, atributos, delegados e assim por diante podem ser não-determinísticos depois de fazer determinados tipos de edições, o que significa que seus valores não confie sempre permanecer o mesmo. Para obter mais informações, consulte a seção valores de elemento de modelo de código podem ser alteradas nas Descobrindo o Código usando o modelo de Código (Visual Basic).

Exemplos

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

Segurança do .NET Framework

Confiança total para o chamador imediato. O membro não pode ser usado por código parcialmente confiável. Para obter mais informações, consulte Usando bibliotecas de código parcialmente confiáveis.