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.
Memproses komentar dokumentasi ke file XML.
Sintaksis
-doc[+ | -]
atau
-doc:file
Argumen
| Istilah | Definisi |
|---|---|
+ | - |
Fakultatif. Menentukan +, atau hanya -doc, menyebabkan pengkompilasi menghasilkan informasi dokumentasi dan menempatkannya dalam file XML. Menentukan - setara dengan tidak menentukan -doc, menyebabkan tidak ada informasi dokumentasi yang dibuat. |
file |
Diperlukan jika -doc: digunakan. Menentukan file XML output, yang diisi dengan komentar dari file kode sumber kompilasi. Jika nama file berisi spasi, kelilingi nama dengan tanda kutip (" "). |
Komentar
Opsi -doc mengontrol apakah pengkompilasi menghasilkan file XML yang berisi komentar dokumentasi. Jika Anda menggunakan -doc:file sintaksis, file parameter menentukan nama file XML. Jika Anda menggunakan -doc atau -doc+, pengkompilasi mengambil nama file XML dari file atau pustaka yang dapat dieksekusi yang dibuat pengkompilasi. Jika Anda menggunakan -doc- atau tidak menentukan -doc opsi , pengkompilasi tidak membuat file XML.
Dalam file kode sumber, komentar dokumentasi dapat mendahului definisi berikut:
Jenis yang ditentukan pengguna, seperti kelas atau antarmuka
Anggota, seperti bidang, peristiwa, properti, fungsi, atau subroutine.
Untuk menggunakan file XML yang dihasilkan dengan fitur Visual Studio IntelliSense , biarkan nama file file XML sama dengan rakitan yang ingin Anda dukung. Pastikan file XML berada di direktori yang sama dengan rakitan sehingga ketika rakitan direferensikan dalam proyek Visual Studio, file .xml juga ditemukan. File dokumentasi XML tidak diperlukan agar IntelliSense berfungsi untuk kode dalam proyek atau dalam proyek yang direferensikan oleh proyek.
Kecuali Anda mengkompilasi dengan -target:module, file XML berisi tag <assembly></assembly>. Tag ini menentukan nama file yang berisi manifes perakitan untuk file output kompilasi.
Lihat Tag Komentar XML untuk cara membuat dokumentasi dari komentar dalam kode Anda.
| Untuk mengatur -doc di lingkungan pengembangan terintegrasi Visual Studio |
|---|
| 1. Pilih proyek di Penjelajah Solusi. Pada menu Proyek, klik Properti. 2. Klik tab Kompilasi . 3. Atur nilai dalam kotak Buat file dokumentasi XML . |
Contoh
Lihat Mendokumen Kode Anda dengan XML untuk sampel.
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.
