<value> (Visual Basic)

Especifica a descrição de uma propriedade.

Sintaxe

<value>property-description</value>  

Parâmetros

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

Observações

Use a <value> marca para descrever uma propriedade. Observe que quando você adiciona uma propriedade usando o assistente de código no ambiente de desenvolvimento do Visual Studio, ela adicionará uma <marca de resumo> para a nova propriedade. Em seguida, você deve adicionar manualmente uma <value> marca para descrever o valor que a propriedade representa.

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

Exemplo

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

''' <summary>
''' Resets the value of 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

• Marcas de comentário XML