<keterangan> (Visual Basic)

2023-04-07

Menentukan bagian keterangan untuk anggota.

Sintaks

<remarks>description</remarks>

Parameter

description
Deskripsi anggota.

Keterangan

Gunakan tag <remarks> untuk menambahkan informasi tentang jenis, melengkapi informasi yang ditentukan dengan <ringkasan>.

Informasi ini muncul di Browser Objek. Untuk informasi tentang Browser Objek, lihat Menampilkan Struktur Kode.

Kompilasi dengan -doc untuk memproses komentar dokumentasi ke file.

Contoh

Contoh ini menggunakan tag <remarks> untuk menjelaskan apa yang dilakukan metode UpdateRecord.

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

Bagikan melalui