<param> (Visual Basic)

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

<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 pour une déclaration de méthode afin de décrire l'un des paramètres pour la méthode.

Le texte de la balise d' <param> apparaîtra dans les emplacements suivants :

• Les informations sur les paramètres Intellisense. Pour plus d’informations, consultez Utilisation de la fonctionnalité IntelliSense.

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

Compilez avec /doc pour traiter les commentaires de documentation et les placer dans un fichier.

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

Référence

Balises XML recommandées pour les commentaires de documentation (Visual Basic)