<paramref> (Visual Basic)

Egy szót paraméterként formáz.

Szemantika

<paramref name="name"/>  

Paraméterek

name
A hivatkozni kívánt paraméter neve. A nevet idézőjelek közé kell foglalni (" ").

Megjegyzések

A <paramref> címke segítségével jelezheti, hogy egy szó paraméter. Az XML-fájl feldolgozható úgy, hogy ezt a paramétert különböző módon formázza.

Fordítás -doc használatával egy fájl dokumentációs megjegyzéseinek feldolgozásához.

példa

Ez a példa a <paramref> címkét használja a id paraméterre való hivatkozáshoz.

''' <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

Lásd még

• XML-megjegyzéscímkék