CA1058: Tipe tidak boleh memperluas tipe dasar tertentu
Properti | Nilai |
---|---|
ID Aturan | CA1058 |
Judul | Jenis tidak boleh memperluas jenis dasar tertentu |
Golongan | Desain |
Perbaikan bersifat disruptif atau non-disruptif | Merusak |
Diaktifkan secara default di .NET 9 | No |
Penyebab
Jenis memperluas salah satu jenis dasar berikut:
- System.ApplicationException
- System.Xml.XmlDocument
- System.Collections.CollectionBase
- System.Collections.DictionaryBase
- System.Collections.Queue
- System.Collections.ReadOnlyCollectionBase
- System.Collections.SortedList
- System.Collections.Stack
Secara default, aturan ini hanya melihat jenis yang terlihat secara eksternal, tetapi ini dapat dikonfigurasi.
Deskripsi aturan
Pengecualian harus berasal dari System.Exception atau salah satu subkelasnya di System namespace layanan.
Jangan membuat subkelas jika Anda ingin membuat tampilan XML dari model objek atau sumber data yang mendasar XmlDocument .
Koleksi non-generik
Gunakan dan/atau perluas koleksi generik jika memungkinkan. Jangan perluas koleksi non-generik dalam kode Anda, kecuali Anda mengirimkannya sebelumnya.
Contoh Penggunaan yang Salah
public class MyCollection : CollectionBase
{
}
public class MyReadOnlyCollection : ReadOnlyCollectionBase
{
}
Contoh Penggunaan yang Benar
public class MyCollection : Collection<T>
{
}
public class MyReadOnlyCollection : ReadOnlyCollection<T>
{
}
Cara memperbaiki pelanggaran
Untuk memperbaiki pelanggaran aturan ini, dapatkan jenis dari jenis dasar yang berbeda atau koleksi generik.
Kapan harus menekan peringatan
Jangan menekan peringatan dari aturan ini untuk pelanggaran tentang ApplicationException. Aman untuk menekan peringatan dari aturan ini untuk pelanggaran tentang XmlDocument. Aman untuk menekan peringatan tentang koleksi non-generik jika kode dirilis sebelumnya.
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 CA1058
// The code that's violating the rule is on this line.
#pragma warning restore CA1058
Untuk menonaktifkan aturan untuk file, folder, atau proyek, atur tingkat keparahannya ke none
dalam file konfigurasi.
[*.{cs,vb}]
dotnet_diagnostic.CA1058.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 XXXX
CAXXXX
dengan ID aturan yang berlaku.