<param> (Visual Basic)

Define un nombre y una descripción de un parámetro.

Sintaxis

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

Parámetros

name
Nombre de un parámetro de método. Ponga el nombre entre comillas dobles (" ").

description
Descripción del parámetro.

Comentarios

La etiqueta <param> debe usarse en el comentario de una declaración de método para describir uno de los parámetros del método.

El texto de la etiqueta <param> aparecerá en las siguientes ubicaciones:

• Información de parámetros de IntelliSense. Para más información, vea Usar IntelliSense.

• Explorador de objetos. Para obtener más información, vea Ver la estructura del código.

Compile con -doc para procesar los comentarios de documentación de un archivo.

Ejemplo

En este ejemplo se usa la etiqueta <param> para describir el 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 también

• Etiquetas de comentario XML