Propriedade CodeClass2.Comment

Artigo
08/01/2011

Define ou obtém o comentário associado à classe de código.

Namespace: EnvDTE80
Assembly: EnvDTE80 (em EnvDTE80.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 o comentário.

Implementações

CodeClass.Comment

Comentários

CommentDefine ou retorna o comentário do cabeçalho para a classe. Texto retornado não contém qualquer sintaxe de comentário. O texto é derivado da fonte com base no estilo de comentário do idioma. Por exemplo, C#, os delimitadores de comentários é / /, mas em Visual Basic, um apóstrofo (') ou o Rem (abreviação de comentário).

Quando definido, Comment tenta manter o estilo de qualquer comentário existente usando o orientado por linhas versus sintaxe delimitado. No processo, ele mantém qualquer recuo antes de sintaxe orientado por linhas, determinando se o comentário toca o elemento de código ou é separado por uma linha em branco.

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

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

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.