Bagikan melalui


Cara: Membuat Dokumentasi XML di Visual Basic

Contoh ini memperlihatkan cara menambahkan komentar dokumentasi XML ke kode Anda.

Nota

Komputer Anda mungkin menampilkan nama atau lokasi yang berbeda untuk beberapa elemen antarmuka pengguna Visual Studio dalam instruksi berikut. Edisi Visual Studio yang Anda miliki dan pengaturan yang Anda gunakan menentukan elemen-elemen ini. Untuk informasi lebih lanjut, lihat Mempersonalisasi IDE.

Untuk membuat dokumentasi XML untuk tipe atau anggota

  1. Di Editor Kode, posisikan kursor Anda pada baris di atas jenis atau anggota yang ingin Anda buat dokumentasinya.

  2. Ketik ''' (tiga tanda kutip tunggal).

    Kerangka XML untuk jenis atau anggota ditambahkan di Editor Kode.

  3. Tambahkan informasi deskriptif antara tag yang sesuai.

    Nota

    Jika Anda menambahkan baris tambahan dalam blok dokumentasi XML, setiap baris harus dimulai dengan '''.

  4. Tambahkan kode tambahan yang menggunakan jenis atau anggota dengan komentar dokumentasi XML baru.

    IntelliSense menampilkan teks dari tag <summary> untuk jenis atau anggota.

  5. Kompilasi kode untuk menghasilkan file XML yang berisi komentar dokumentasi. Untuk informasi selengkapnya, lihat -doc.

Lihat juga