Udostępnij za pośrednictwem

<paramref> (Visual Basic)

  • Artykuł

Formatuje wyraz jako parametr.

Składnia

<paramref name="name"/>

Parametry

name
Nazwa parametru do odwoływania się do. Ujęć nazwę w podwójny cudzysłów (" ").

Uwagi

Tag <paramref> umożliwia wskazanie, że słowo jest parametrem. Plik XML można przetworzyć w celu sformatowania tego parametru w odrębny sposób.

Skompiluj za pomocą -doc , aby przetworzyć komentarze dokumentacji do pliku.

Przykład

W tym przykładzie użyto tagu <paramref> do odwoływania się do parametru 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

Zobacz też