Bagikan melalui

Mendokumentasikan kode Anda dengan XML (Visual Basic)

  • Artikel

Dalam Visual Basic, Anda dapat mendokumentasikan kode Anda menggunakan XML.

Komentar dokumentasi XML

Visual Basic menyediakan cara mudah untuk membuat dokumentasi XML secara otomatis untuk proyek. Anda dapat secara otomatis membuat kerangka XML untuk jenis dan anggota Anda, lalu memberikan ringkasan, dokumentasi deskriptif untuk setiap parameter, dan keterangan lainnya. Dengan penyiapan yang sesuai, dokumentasi XML secara otomatis dikirim ke file XML dengan nama file akar yang sama dengan proyek Anda. Untuk informasi tentang mengonfigurasi pembuatan file dokumentasi XML, lihat -opsi kompilator dokumen dan properti MSBuild GenerateDocumentationFile.

File XML dapat digunakan atau dimanipulasi sebagai XML. File ini terletak di direktori yang sama dengan file .exe atau .dll output proyek Anda.

Dokumentasi XML dimulai dengan '''. Pemrosesan komentar ini memiliki beberapa batasan:

  • Dokumentasi harus berupa XML terbentuk. Jika XML tidak terbentuk dengan baik, peringatan akan dibuat dan file dokumentasi berisi komentar yang mengatakan bahwa telah terjadi kesalahan.

  • Pengembang bebas membuat kumpulan tag mereka sendiri. Ada kumpulan tag yang disarankan (lihat Tag Komentar XML). Beberapa tag yang direkomendasikan memiliki arti khusus:

    • Tag <param> digunakan untuk menjelaskan parameter. Jika digunakan, kompilator akan memverifikasi bahwa parameter ada dan semua parameter dijelaskan dalam dokumentasi. Jika verifikasi gagal, kompilator mengeluarkan peringatan.

    • Atribut cref dapat dilampirkan ke tag apa pun untuk memberikan referensi ke elemen kode. Kompilator memverifikasi bahwa elemen kode ini ada. Jika verifikasi gagal, kompilator mengeluarkan peringatan. Kompilator juga menghormati pernyataan Imports saat mencari jenis yang dijelaskan dalam atribut cref.

    • Tag <ringkasan> digunakan oleh IntelliSense di Visual Studio untuk menampilkan informasi tambahan tentang jenis atau anggota.

Untuk detail tentang membuat file XML dengan komentar dokumentasi, lihat topik berikut:

Lihat juga