Compartilhar via


Propriedade CodeVariable2.DocComment

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

Namespace:  EnvDTE80
Assembly:  EnvDTE80 (em EnvDTE80.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: String
Uma cadeia de caracteres que representa o comentário do documento.

Comentários

DocComment retorna o comentário ou atributo especial da documentação se houver um no código. Se o idioma que implementa o modelo de código não tem um mecanismo de comentário da documentação, ou se não houver nenhum associados ao elemento de código, então DocComment retorna uma cadeia de caracteres vazia.

Dica

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

Além disso, os valores de código de modelagem elementos como classes, estruturas, funções, atributos, representantes, e assim por diante podem ser não determinísticas depois de fazer determinados tipos as edições do, o que significa que seus valores não podem ser confiáveis em para permanecer sempre os mesmos.Para obter mais informações, veja que os valores do elemento do modelo de código da seção podem ser alteradas em Descobrindo código usando o modelo de código (Visual Basic).

Segurança do .NET Framework

Consulte também

Referência

CodeVariable2 Interface

Namespace EnvDTE80

Outros recursos

Como compilar e executar os exemplos de código do modelo de objeto Automation

Descobrindo código usando o modelo de código (Visual Basic)

Descobrindo código usando o modelo de código (Visual C#)