Propriedade CodeParameter.DocComment

Artigo
08/01/2011

Retorna o comentário do documento para o elemento de modelo de código atual.

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

Sintaxe

'Declaração
Property DocComment As String
    Get
    Set

string DocComment { get; set; }

property String^ DocComment {
    String^ get ();
    void set (String^ value);
}

abstract DocComment : string with get, set

function get DocComment () : String
function set DocComment (value : String)

Valor de propriedade

Tipo: System.String
Uma seqüência de caracteres que representa o comentário do documento.

Comentários

DocCommentRetorna o comentário de documentação especial ou um atributo, se houver no código. Se a implementação do modelo de código de linguagem não tem um mecanismo de comentário de documentação, ou se não houver nenhum associado com o elemento de código, em seguida, DocComment retorna uma seqüência de caracteres vazia.

Observação
Esta propriedade é somente leitura para os elementos de código do código de fonte de Visual Basic. Além disso, 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).

Esta propriedade é somente leitura para os elementos de código do código de fonte de Visual Basic.

Além disso, 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).

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.