Catatan
Akses ke halaman ini memerlukan otorisasi. Anda dapat mencoba masuk atau mengubah direktori.
Akses ke halaman ini memerlukan otorisasi. Anda dapat mencoba mengubah direktori.
Pengkompilasi 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.
Nota
Komentar dokumentasi tidak dapat diterapkan ke namespace. Alasannya adalah bahwa satu namespace dapat menjangkau beberapa rakitan, dan tidak semua rakitan harus dimuat pada saat yang sama.
Pengkompilasi memproses tag apa pun yang merupakan XML yang valid. Tag berikut menyediakan fungsionalitas yang umum digunakan dalam dokumentasi pengguna.
- <c>
- <kode>
- <contoh>
- <pengecualian>1
- <sertakan>1
- <daftar>
- <para>
- <param>1
- <paramref>
- <izin>1
- <Komentar>
- <Kembali>
- <lihat>1
- <seealso>1
- <ringkasan>
- <typeparam>1
- <typeparamref>
- <nilai>
(1 Pengkompilasi memverifikasi sintaksis.)
Nota
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>.
Lihat juga
Berkolaborasi dengan kami di GitHub
Sumber untuk konten ini dapat ditemukan di GitHub, yang juga dapat Anda gunakan untuk membuat dan meninjau masalah dan menarik permintaan. Untuk informasi selengkapnya, lihat panduan kontributor kami.
