<param> (Visual Basic)

Paraméternevet és leírást határoz meg.

Szemantika

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

Paraméterek

name
Egy metódusparaméter neve. A nevet idézőjelek közé kell foglalni (" ").

description
A paraméter leírása.

Megjegyzések

A <param> címkét a metódus deklarációjának megjegyzésében kell használni a metódus egyik paraméterének leírásához.

A címke szövege a <param> következő helyeken jelenik meg:

• Az IntelliSense paraméterinformációja. További információ: Az IntelliSense használata.

• Objektumböngésző. További információ: A kód struktúrájának megtekintése.

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 <param> címke használatával írja le a paramétert 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

Lásd még

• XML-megjegyzéscímkék