Compartilhar via

<value> (Visual Basic)

  • Artigo

Especifica a descrição de uma propriedade.

<value>property-description</value>

Parâmetros

  • property-description
    Uma descrição para a propriedade.

Comentários

Use o marcador <value> para descrever uma propriedade.Note que quando você adiciona uma propriedade usando o assistente de código no ambiente de desenvolvimento do Visual Studio, este vai adicionar um marcador <resumo> (Visual Basic) para a nova propriedade.Você pode, então, manualmente adicionar um marcador <value> para descrever o valor que a propriedade representa.

Compile com /doc para processar os comentários de documentação para um arquivo.

Exemplo

Este exemplo usa o marcador <value> para descrever qual valor a propriedade Counter contém.

''' <summary>
''' Resets the value the <c>Counter</c> field.
''' </summary>
Public Sub ResetCounter()
    counterValue = 0
End Sub
Private counterValue As Integer = 0
''' <summary>
''' Returns the number of times Counter was called.
''' </summary>
''' <value>Number of times Counter was called.</value>
Public ReadOnly Property Counter() As Integer
    Get
        counterValue += 1
        Return counterValue
    End Get
End Property

Consulte também

Referência

Recomendado marcas XML para comentários da documentação (Visual Basic)