Propriedade CodeFunction2.DocComment

Artigo
08/01/2011

Obtém ou define o comentário de documento para o elemento de modelo de código atual.

Namespace: EnvDTE80
Assembly: EnvDTE80 (em EnvDTE80.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.

Implementações

CodeFunction.DocComment

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 há nenhum associado do elemento de código, em seguida, DocComment retorna uma seqüência de caracteres vazia.

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).

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.