<param> (Visual Basic)

Definisce un nome e una descrizione di parametro.

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

Parametri

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

• description
  Descrizione del parametro.

Note

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

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

• Informazioni sul parametro IntelliSense.Per ulteriori informazioni, vedere Utilizzo di IntelliSense.

• Visualizzatore oggetti.Per ulteriori informazioni, vedere Visualizzazione della struttura del codice.

Eseguire la compilazione con /doc per elaborare in un file i commenti relativi alla documentazione.

Esempio

In questo esempio il tag <param> viene utilizzato 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

Vedere anche

Riferimenti

Tag XML consigliati per i commenti relativi alla documentazione (Visual Basic)