Condividi tramite

<paramref> (Visual Basic)

  • Articolo

Formatta una parola come parametro.

<paramref name="name"/>

Parametri

  • name
    Nome del parametro a cui fare riferimento. Racchiudere il nome tra virgolette doppie (" ").

Note

Il tag <paramref> consente di indicare che una parola è un parametro. Il file XML può essere elaborato in modo da formattare il parametro in maniera specifica.

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

Esempio

In questo esempio il tag <paramref> viene utilizzato per fare riferimento al 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)