Dokumentasi XML (Visual C++)

Di Visual C++, Anda dapat menambahkan komentar ke kode sumber yang diproses ke file dokumentasi XML. File ini kemudian dapat menjadi input ke proses yang membuat dokumentasi untuk kelas dalam kode Anda.

Dalam file kode Visual C++, komentar dokumentasi XML harus terletak langsung sebelum metode atau definisi jenis. Komentar dapat digunakan untuk mengisi tip data IntelliSense QuickInfo dalam skenario berikut:

1. Ketika kode dikompilasi sebagai komponen Windows Runtime dengan file WINMD

2. Ketika kode sumber disertakan dalam proyek saat ini

3. Dalam pustaka yang jenis deklarasi dan implementasinya terletak di file header yang sama

Catatan

Dalam rilis saat ini, komentar kode tidak diproses pada templat atau apa pun yang berisi jenis templat (misalnya, fungsi yang mengambil parameter sebagai templat). Menambahkan komentar tersebut akan mengakibatkan perilaku yang tidak terdefinisi.

Untuk detail tentang membuat file XML dengan komentar dokumentasi, lihat artikel berikut ini.

Untuk informasi tentang	Lihat
Opsi pengkompilasi untuk digunakan	/doc
Tag yang dapat Anda gunakan untuk menyediakan fungsionalitas yang umum digunakan dalam dokumentasi	Tag yang direkomendasikan untuk komentar dokumentasi
String ID yang dihasilkan pengkompilasi untuk mengidentifikasi konstruksi dalam kode Anda	Memproses File XML
Cara memisahkan tag dokumentasi	Pemisah untuk tag dokumentasi Visual C++
Membuat file XML dari satu atau beberapa file XDC.	Referensi XDCMake
Tautan ke informasi tentang XML karena berkaitan dengan area fitur Visual Studio	XML di Visual Studio

Jika Anda perlu meletakkan karakter khusus XML dalam teks komentar dokumentasi, Anda harus menggunakan entitas XML atau bagian CDATA.

Baca juga

Ekstensi komponen untuk platform runtime