Propriedade CodeEnum.Comment

Artigo
08/01/2011

Obtém ou define o comentário associado ao elemento de código.

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 o comentário associado ao elemento de código.

Comentários

CommentDefine ou retorna o comentário do cabeçalho. Quando retornado, o texto não contém a 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 dos comentários existentes usando o orientado por linhas versus sintaxe delimitado, mantendo 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 e assim por diante.

Observação
Os valores dos elementos de modelo de código, como, por exemplo, classes, estruturas, funções, atributos, delegados, não confie permaneça o mesmo em todos os tempos. 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).

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.