<summary> (Visual Basic)

  • Artigo

Especifica o resumo do membro.

<summary>description</summary>

Parâmetros

  • description
    Um resumo do objeto.

Comentários

Use a etiqueta <summary> para descrever um tipo ou um membro de tipo.Use <remarks> (Visual Basic) para adicionar informações suplementares a uma descrição de tipo.

O texto para a marca de <summary> é a única ofnte de informações sobre o tipo IntelliSense, e também é exibido no pesquisador de objetos.Para obter informações sobre o pesquisador de objetos, consulte Exibindo a estrutura de código.

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

Exemplo

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

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