Propriedade CodeStruct.DocComment

Artigo
10/26/2012

Obtém ou define o comentário do documento atual CodeStruct.

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

Sintaxe

'Declaração
Property DocComment As String

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
Um string que representa o comentário do documento atual CodeStruct.

Comentários

DocCommentRetorna o comentário de documentação especial ou um atributo, se houver um 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 vazia.

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

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

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

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.