Bagikan melalui

Dokumentasikan kode Anda dengan XML (Visual Basic)

Di Visual Basic, Anda bisa mendokumenkan 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 komentar lainnya. Dengan penyiapan yang sesuai, dokumentasi XML secara otomatis dipancarkan ke dalam file XML dengan nama file akar yang sama dengan proyek Anda. Untuk informasi tentang mengonfigurasi pembuatan file dokumentasi XML, lihat opsi pengkompilasi -doc dan properti GenerateDocumentationFile MSBuild.

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

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

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

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

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

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

    • Tag <summary> 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 ini:

Lihat juga

  • Last updated on