<resumo> (Visual Basic)

Especifica o resumo do membro.

Sintaxe

<summary>description</summary>  

Parâmetros

description
Um resumo do objeto.

Observações

Use a <summary> marca para descrever um tipo ou um membro de tipo. Use <remarks> para adicionar mais informações a uma descrição de tipo.

O texto da <summary> marca é a única fonte de informações sobre o tipo no IntelliSense e também é exibido no Pesquisador de Objetos. Para obter informações sobre o Pesquisador de Objetos, consulte Exibindo a estrutura do código.

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

Exemplo

Este exemplo usa a <summary> marca para descrever o método e Counter a ResetCounter propriedade.

''' <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