<param> (Visual Basic)

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

<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> se debe utilizar 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 obtener más información, vea Utilizar IntelliSense.

• Examinador 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 en un archivo.

Ejemplo

En este ejemplo se utiliza 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

Vea también

Referencia

Etiquetas XML recomendadas para comentarios de documentación (Visual Basic)