<param> (Visual Basic)

  • Makale

Bir parametre adı ve açıklaması tanımlar.

Sözdizimi

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

Parametreler

name
Yöntem parametresinin adı. Adı çift tırnak işareti (" ") içine alın.

description
parametresi için bir açıklama.

Açıklamalar

etiketi, <param> yöntemin parametrelerinden birini açıklamak üzere bir yöntem bildiriminin açıklamasında kullanılmalıdır.

Etiketin <param> metni aşağıdaki konumlarda görünür:

  • IntelliSense'in Parametre Bilgileri. Daha fazla bilgi için bkz . IntelliSense kullanma.

  • Nesne Tarayıcısı. Daha fazla bilgi için bkz . Kod Yapısını Görüntüleme.

Belge açıklamalarını bir dosyaya işlemek için -doc ile derleyin.

Örnek

Bu örnekte parametresini <param> açıklamak id için etiketi kullanılır.

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

Ayrıca bkz.