CA1058: Tipe tidak boleh memperluas tipe dasar tertentu

Properti Nilai
ID Aturan CA1058
Judul Jenis tidak boleh memperluas jenis dasar tertentu
Kategori Desain
Perbaikan bersifat merusak atau tidak merusak Merusak
Diaktifkan secara default di .NET 10 Tidak
Bahasa yang berlaku C# dan Visual Basic

Penyebab

Jenis memperluas salah satu jenis dasar berikut:

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.

Jangan membuat subkelas XmlDocument jika Anda ingin membuat tampilan XML dari model objek atau sumber data.

Koleksi non-generik

Gunakan dan/atau perluas koleksi generik jika memungkinkan. Jangan menambah koleksi non-generik dalam kode Anda, kecuali jika Anda sudah 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, turunkan tipe dari tipe dasar lain atau dari koleksi generik.

Kapan harus menekan peringatan

Jangan menekan peringatan dari aturan ini untuk pelanggaran yang berkaitan dengan ApplicationException. Aman untuk menekan peringatan dari aturan ini untuk pelanggaran tentang XmlDocument. Aman untuk menekan peringatan tentang koleksi non-generik jika kode telah 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 XXXXCAXXXX dengan ID aturan yang berlaku.

  • Last updated on