CA1005: Menghindari parameter yang berlebihan pada jenis generik
| Properti | Nilai |
|---|---|
| ID Aturan | CA1005 |
| Judul | Hindari parameter yang berlebihan pada jenis generik |
| Golongan | Desain |
| Perbaikan bersifat disruptif atau non-disruptif | Merusak |
| Diaktifkan secara default di .NET 9 | No |
Penyebab
Jenis generik yang terlihat secara eksternal memiliki lebih dari dua parameter jenis.
Secara default, aturan ini hanya melihat jenis yang terlihat secara eksternal, tetapi ini dapat dikonfigurasi.
Deskripsi aturan
Semakin banyak parameter jenis yang dimiliki oleh jenis generik, semakin sulit untuk mengetahui dan mengingat apa yang diwakili oleh setiap parameter jenis. Biasanya jelas dengan satu parameter jenis, seperti dalam List<T>, dan dalam kasus tertentu dengan dua parameter jenis, seperti dalam Dictionary<TKey, TValue>. Jika ada lebih dari dua parameter jenis, kesulitan menjadi terlalu besar untuk sebagian besar pengguna (misalnya, TooManyTypeParameters<T, K, V> di C# atau TooManyTypeParameters(Of T, K, V) di Visual Basic).
Cara memperbaiki pelanggaran
Untuk memperbaiki pelanggaran aturan ini, ubah desain untuk menggunakan tidak lebih dari dua parameter jenis.
Kapan harus menekan peringatan
Jangan menekan peringatan dari aturan ini kecuali desain benar-benar memerlukan lebih dari dua parameter jenis. Menyediakan generik dalam sintaks yang mudah dipahami dan digunakan mengurangi waktu yang diperlukan untuk mempelajari dan meningkatkan tingkat adopsi pustaka baru.
Menyembunyikan peringatan
Jika Anda hanya ingin menyembunyikan satu pelanggaran, tambahkan arahan praprosedur ke file sumber Anda untuk dinonaktifkan lalu aktifkan kembali aturannya.
#pragma warning disable CA1005
// The code that's violating the rule is on this line.
#pragma warning restore CA1005
Untuk menonaktifkan aturan untuk file, folder, atau proyek, atur tingkat keparahannya ke none dalam file konfigurasi.
[*.{cs,vb}]
dotnet_diagnostic.CA1005.severity = none
Untuk informasi selengkapnya, lihat Cara menyembunyikan peringatan analisis kode.
Mengonfigurasi kode yang akan dianalisis
Gunakan opsi berikut untuk mengonfigurasi bagian mana dari codebase Anda yang akan menjalankan aturan ini.
Anda dapat mengonfigurasi opsi ini hanya untuk aturan ini, untuk semua aturan yang berlaku untuknya, atau untuk semua aturan dalam kategori ini (Desain) yang berlaku untuk aturan ini. Untuk informasi selengkapnya, lihat Opsi konfigurasi aturan kualitas kode.
Menyertakan permukaan API tertentu
Anda dapat mengonfigurasi bagian basis kode mana yang akan dijalankan aturan ini, berdasarkan aksesibilitasnya, dengan mengatur opsi api_surface. Misalnya, untuk menentukan bahwa aturan hanya boleh dijalankan pada permukaan API non-publik, tambahkan pasangan kunci-nilai berikut ke file .editorconfig di proyek Anda:
dotnet_code_quality.CAXXXX.api_surface = private, internal
Nota
Ganti bagian XXXXCAXXXX dengan ID aturan yang berlaku.
Aturan terkait
CA1010: Pengumpulan harus menerapkan antarmuka generik
CA1000: Jangan deklarasikan anggota statis pada jenis generik
CA1002: Jangan mengekspos daftar generik
CA1003: Menggunakan instans penanganan aktivitas generik
