Propriedade CodeEvent.Comment

Artigo
10/26/2012

Obtém ou define um comentário de cabeçalho associado ao elemento do código de evento.

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

Sintaxe

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

Valor de propriedade

Tipo: System.String
Uma seqüência de caracteres que contém um comentário do cabeçalho ou uma seqüência vazia se nenhum comentário for fornecido.

Comentários

Texto recuperado 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, em C#, os delimitadores de comentários é / /, mas em Visual Basic, é um apóstrofo (') ou o Rem (abreviação de comentário).

Quando definido, o Comment propriedade tenta manter o estilo de qualquer comentário existente usando orientado por linhas versus sintaxe delimitado.No processo, ele mantém qualquer recuo antes para a 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 de 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 alterada de Descobrindo o código usando o modelo de código (Visual Basic).

Os valores de 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 alterada de Descobrindo o código usando o modelo de código (Visual Basic).

Exemplos

O exemplo a seguir demonstra como usar o Comment propriedade.

Para testar essa propriedade:

Abra o projeto de destino e selecione o elemento do código de evento, colocando o cursor sobre o objeto de evento.
Execute o add-in.

public static void Comment(EnvDTE80.DTE2 dte)
{
    TextSelection objTextSel;
    EnvDTE80.CodeEvent codeEvent;
    objTextSel = (TextSelection)dte.ActiveDocument.Selection;
    codeEvent = (EnvDTE80.CodeEvent)objTextSel.ActivePoint.get_CodeElement(vsCMElement.vsCMElementEvent);

    MessageBox.Show("\nComment property: " +
                    codeEvent.Comment, "Testing CodeEvent");
}

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.