Penjelasan dan Contoh Sederhana XML Documentation Comments C# Asp.Net


Dalam Visual C # kita dapat membuat dokumentasi untuk code kita dengan menyertakan elemen XML di field komentar khusus (ditunjukkan dengan triple slashes) di source code secara langsung sebelum blok code yang komentar merujuk, misalnya:
///   
///  This class performs an important function.  
///   
public class MyClass{}  

Saat kita mengkompilasi dengan opsi / doc, kompilator akan mencari semua tag XML di source code dan membuat file dokumentasi XML. Untuk membuat dokumentasi akhir berdasarkan file yang dihasilkan kompilator, kita bisa membuat custom tool atau menggunakan tool seperti Sandcastle.

Untuk merujuk pada elemen XML (misalnya, fungsi kita memproses elemen XML tertentu yang ingin kita jelaskan dalam komentar dokumentasi XML), kita dapat menggunakan mekanisme kutipan standar ()

Untuk merujuk pada pengenal generik dalam elemen referensi kode (cref), kita dapat menggunakan karakter escape (misalnya, cref = "List ") atau braces (cref = "List {T}"). Sebagai kasus khusus, kompilator mem-parsing braces sebagai tanda kurung siku untuk membuat komentar dokumentasi menjadi tidak rumit bagi penulis saat merujuk ke pengenal generik.
Previous
Next Post »