Bagikan melalui

-doc

  • Artikel

Memproses komentar dokumentasi ke file XML.

Sintaks

-doc[+ | -]

or

-doc:file

Argumen

Term Definisi
+ | - Opsional. 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 memiliki spasi, kelilingi nama dengan tanda kutip (" ").

Keterangan

Opsi -doc mengontrol apakah pengkompilasi menghasilkan file XML yang berisi komentar dokumentasi. Jika Anda menggunakan sintaks -doc:file, parameter file 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 opsi -doc, pengkompilasi tidak membuat file XML.

Dalam file kode sumber, komentar dokumentasi dapat mendahului definisi berikut:

Untuk menggunakan file XML yang dihasilkan dengan fitur IntelliSense Visual Studio, biarkan nama file dari file XML sama dengan rakitan yang ingin Anda dukung. Pastikan file XML berada dalam direktori yang sama dengan rakitan sehingga ketika rakitan direferensikan dalam proyek Visual Studio, file .xml juga ditemukan. File dokumentasi XML tidak diperlukan untuk IntelliSense berfungsi untuk kode dalam proyek atau dalam proyek yang direferensikan oleh suatu proyek.

Kecuali jika Anda mengkompilasi dengan -target:module, file XML memiliki tag <assembly></assembly>. Tag ini menentukan nama file yang berisi manifes rakitan untuk file output kompilasi.

Lihat Tag Komentar XML untuk cara menghasilkan dokumentasi dari komentar dalam kode Anda.

Untuk mengatur -doc di IDE 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 Mendokumentasikan Kode Anda dengan XML untuk sampel.

Lihat juga