<summary> (Visual Basic)

  • Artigo

Especifica o resumo do membro.

Sintaxe

<summary>description</summary>

Parâmetros

description
Um resumo do objeto.

Comentários

Use a marca <summary> 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 marca <summary> é a única fonte de informações sobre o tipo no IntelliSense e também é exibido no Pesquisador de objetos. Para obter mais informações sobre o Pesquisador de Objetos, consulte Exibir a estrutura do código.

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

Exemplo

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

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

Confira também