<param> (Visual Basic)

Menentukan nama parameter dan deskripsi.

Sintaks

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

Parameter

name
Nama parameter metode. Sertakan nama dalam tanda kutip ganda (" ").

description
Deskripsi untuk parameter.

Keterangan

Tag <param> harus digunakan dalam komentar untuk deklarasi metode guna menjelaskan salah satu parameter metode.

Teks untuk tag <param> akan muncul di lokasi berikut:

• Info Parameter IntelliSense. Untuk informasi selengkapnya, lihat Menggunakan IntelliSense.

• Browser Objek. Untuk informasi selengkapnya, lihat Menampilkan Struktur Kode.

Kompilasi dengan -doc untuk memproses komentar dokumentasi ke file.

Contoh

Contoh ini menggunakan tag <param> untuk merujuk ke parameterid.

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

Lihat juga

• Tag Komentar XML