<param> (Visual Basic)

Definisce il nome e la descrizione di un parametro.

Sintassi

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

Parametri

name
Nome di un parametro di metodo. Racchiudere il nome tra virgolette doppie (" ").

description
Descrizione del parametro.

Osservazioni:

Il tag <param> viene usato nel commento di una dichiarazione di metodo per descrivere uno dei parametri del metodo.

Il testo del tag <param> verrà visualizzato nelle posizioni seguenti:

• Informazioni parametro di IntelliSense. Per altre informazioni, vedere Using IntelliSense.

• Visualizzatore oggetti. Per altre informazioni, vedere Viewing the Structure of Code (Visualizzazione della struttura del codice).

Compilare con -doc per elaborare i commenti relativi alla documentazione in un file.

Esempio

In questo esempio viene usato il tag <param> per descrivere il parametro 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

Vedi anche

• Tag di commento XML