Bagikan melalui

Aturan dokumentasi

  • Artikel

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

Di bagian ini

Aturan Deskripsi
CA1200: Hindari menggunakan tag cref dengan prefiks Atribut cref dalam tag dokumentasi XML berarti "referensi kode". Atribut ini menentukan bahwa teks bagian dalam dari tag adalah elemen kode, seperti jenis, metode, atau properti. Hindari menggunakan tag cref dengan prefiks, karena mencegah kompilator memverifikasi referensi. Ini juga mencegah integrated development environment (IDE) Visual Studio dari menemukan dan memperbarui referensi simbol ini selama refaktor.