<param> (Visual Basic)

  • Artigo

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

Sintaxe

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

Parâmetros

name
O nome do parâmetro de um método. Coloque o nome entre aspas duplas (" ").

description
Uma descrição do parâmetro.

Comentários

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

O texto da marca <param> será exibido nos seguintes locais:

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

Exemplo

Este exemplo usa a marca <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

Confira também