Tag XML yang Direkomendasikan untuk Komentar Dokumentasi (Visual Basic)
Kompiler Visual Basic dapat memproses komentar dokumentasi dalam kode Anda ke file XML. Anda dapat menggunakan alat tambahan untuk memproses file XML ke dalam dokumentasi.
Komentar XML diizinkan pada konstruksi kode seperti jenis dan jenis anggota. Untuk jenis parsial, hanya satu bagian dari jenis yang dapat memiliki komentar XML, meskipun tidak ada batasan untuk mengomentari anggotanya.
Catatan
Komentar dokumentasi tidak dapat diterapkan ke namespace layanan. Alasannya adalah bahwa satu namespace dapat menjangkau beberapa rakitan, dan tidak semua rakitan harus dimuat pada saat yang sama.
Kompiler memproses tag apa pun yang merupakan XML yang valid. Tag berikut menyediakan fungsionalitas yang umum digunakan dalam dokumentasi pengguna.
- <c>
- <kode>
- <contoh>
- <pengecualian>1
- <termasuk>1
- <daftar>
- <para>
- <param>1
- <paramref>
- <izin>1
- <keterangan>
- <pengembalian>
- <lihat>1
- <lihatjuga>1
- <ringkasan>
- <jenisparam>1
- <nilai>
(1 Kompiler memverifikasi sintaks.)
Catatan
Jika Anda ingin tanda kurung sudut muncul dalam teks komentar dokumentasi, gunakan < dan >. Misalnya, string "<text in angle brackets>" akan muncul sebagai <text in angle brackets>.