Bagikan melalui


Aturan dokumentasi

Aturan dokumentasi mendukung penulisan pustaka yang didokumentasikan dengan baik melalui penggunaan komentar dokumentasi XML yang benar untuk API yang terlihat secara eksternal.

Di bagian ini

Peraturan Deskripsi
CA1200: Hindari menggunakan tag cref dengan awalan Atribut cref dalam tag dokumentasi XML berarti "referensi kode". Ini menentukan bahwa teks dalam tag adalah elemen kode, seperti jenis, metode, atau properti. Hindari menggunakan tag cref dengan awalan, karena mencegah pengkompilasi memverifikasi referensi. Ini juga mencegah lingkungan pengembangan terintegrasi Visual Studio (IDE) menemukan dan memperbarui referensi simbol ini selama pemfaktoran ulang.