<param> (Visual Basic)

Define o nome e descrição de um parâmetro.

<param name="name">description</param>

Parâmetros

• name
  O nome do parâmetro de um método.Envolva o nome em aspas duplas (" ").

• description
  Uma descrição para o parâmetro.

Comentários

A tag <param> deveria ser usada no comentário para uma declaração de método para descrever um dos parâmetros do método.

O texto para a marca de <param> aparecerá nos seguintes locais:

• Informações de parâmetro do IntelliSense.Para obter mais informações, consulte Usando IntelliSense.

• pesquisador de objetos.Para obter mais informações, 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 tag <param> para descrever o parâmetro id.

''' <param name="id">The ID of the record to update.</param>
''' <remarks>Updates the record <paramref name="id"/>.
''' <para>Use <see cref="DoesRecordExist"/> to verify that
''' the record exists before calling this method.</para>
''' </remarks>
Public Sub UpdateRecord(ByVal id As Integer)
    ' Code goes here.
End Sub
''' <param name="id">The ID of the record to check.</param>
''' <returns><c>True</c> if <paramref name="id"/> exists,
''' <c>False</c> otherwise.</returns>
''' <remarks><seealso cref="UpdateRecord"/></remarks>
Public Function DoesRecordExist(ByVal id As Integer) As Boolean
    ' Code goes here.
End Function

Consulte também

Referência

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