<param> (Visual Basic)

Définit un nom et une description de paramètre.

Syntaxe

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

Paramètres

name
Nom d’un paramètre de méthode. Mettez le nom entre guillemets doubles (" ").

description
Description du paramètre.

Notes

La balise <param> doit être utilisée dans le commentaire d’une déclaration de méthode pour décrire l’un des paramètres de la méthode.

Le texte de la balise <param> s’affiche aux emplacements suivants :

• Informations sur les paramètres d’IntelliSense. Pour plus d’informations, consultez Utilisation d’IntelliSense.

• Explorateur d’objets. Pour plus d’informations, consultez Affichage de la structure du code.

Compilez avec -doc pour placer les commentaires de documentation dans un fichier en vue de les traiter.

Exemple

Cet exemple utilise la balise <param> pour décrire le paramètre 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

Voir aussi

• Étiquettes XML pour les commentaires