<param> (Visual Basic)

Definiuje nazwę parametru i opis.

Składnia

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

Parametry

name
Nazwa parametru metody. Ujęć nazwę w podwójny cudzysłów (" ").

description
Opis parametru.

Uwagi

Tag <param> powinien być używany w komentarzu dla deklaracji metody, aby opisać jeden z parametrów metody.

Tekst tagu <param> zostanie wyświetlony w następujących lokalizacjach:

• Informacje o parametrach funkcji IntelliSense. Aby uzyskać więcej informacji, zobacz Using IntelliSense (Używanie funkcji IntelliSense).

• Przeglądarka obiektów. Aby uzyskać więcej informacji, zobacz Wyświetlanie struktury kodu.

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

Przykład

W tym przykładzie użyto tagu <param> do opisania 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ż

• Tagi komentarza XML