<param> (Visual Basic)

Definiuje parametr Nazwa i opis.

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

Parametry

• name
  Nazwa parametru metody.Nazwę należy ująć w podwójny cudzysłów ("").

• description
  Opis parametru.

Uwagi

<param> Tag powinny być stosowane w komentarz dla deklaracji metody do opisania jeden z parametrów metody.

Tekst dla <param> tag pojawią się w następujących lokalizacjach:

• Informacje o parametrach IntelliSense.Aby uzyskać więcej informacji, zobacz Korzystanie z IntelliSense.

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

Kompilacji z /doc do procesu dokumentacji komentarze do pliku.

Przykład

W poniższym przykładzie użyto <param> tag, aby opisać id parametru.

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

Informacje

Zalecane tagi XML dla komentarzy dokumentacji (Visual Basic)