CA1040: Hindari antarmuka kosong

Item Nilai
RuleId CA1040
Kategori Desain
Perbaikan bersifat disruptif atau non-disruptif Pelanggaran

Penyebab

Antarmuka tidak mendeklarasikan anggota atau mengimplementasikan dua atau lebih antarmuka lainnya.

Secara default, aturan ini hanya melihat antarmuka yang terlihat secara eksternal, tetapi ini dapat dikonfigurasi.

Deskripsi aturan

Antarmuka menentukan anggota yang menyediakan perilaku atau kontrak penggunaan. Fungsionalitas yang dijelaskan oleh antarmuka dapat diadopsi oleh jenis apa pun, terlepas dari di mana jenis muncul dalam hierarki pewarisan. Jenis mengimplementasikan antarmuka dengan menyediakan implementasi untuk anggota antarmuka. Antarmuka kosong tidak menentukan anggota apa pun. Oleh karena itu, itu tidak mendefinisikan kontrak yang dapat diimplementasikan.

Jika desain Anda menyertakan antarmuka kosong yang jenisnya diharapkan untuk diterapkan, Anda mungkin menggunakan antarmuka sebagai penanda atau cara untuk mengidentifikasi sekelompok jenis. Jika identifikasi ini akan terjadi pada durasi, cara yang benar untuk mencapainya adalah dengan menggunakan atribut kustom. Gunakan keberadaan atau tidak adanya atribut, atau properti atribut , untuk mengidentifikasi jenis target. Jika identifikasi harus terjadi pada waktu kompilasi, maka dapat diterima untuk menggunakan antarmuka kosong.

Cara memperbaiki pelanggaran

Hapus antarmuka atau tambahkan anggota ke antarmuka tersebut. Jika antarmuka kosong digunakan untuk memberi label sekumpulan jenis, ganti antarmuka dengan atribut kustom.

Kapan harus menyembunyikan peringatan

Aman untuk menekan peringatan dari aturan ini ketika antarmuka digunakan untuk mengidentifikasi sekumpulan jenis pada waktu kompilasi.

Menyembunyikan peringatan

Jika Anda hanya ingin menekan satu pelanggaran, tambahkan arahan pra-prosesor ke file sumber Anda untuk dinonaktifkan lalu aktifkan kembali aturan.

#pragma warning disable CA1040
// The code that's violating the rule is on this line.
#pragma warning restore CA1040

Untuk menonaktifkan aturan untuk file, folder, atau proyek, atur tingkat keparahannya ke none dalam file konfigurasi.

[*.{cs,vb}]
dotnet_diagnostic.CA1040.severity = none

Untuk menonaktifkan seluruh kategori aturan ini, atur tingkat keparahan untuk kategori none ke dalam file konfigurasi.

[*.{cs,vb}]
dotnet_analyzer_diagnostic.category-Design.severity = none

Untuk informasi selengkapnya, lihat Cara menekan peringatan analisis kode.

Mengonfigurasi kode yang akan dianalisis

Gunakan opsi berikut untuk mengonfigurasi bagian mana dari basis kode Anda untuk menjalankan aturan ini.

Anda dapat mengonfigurasi opsi ini hanya untuk aturan ini, untuk semua aturan, atau untuk semua aturan dalam kategori ini (Desain). Untuk informasi selengkapnya, lihat Opsi konfigurasi aturan kualitas kode.

Menyertakan permukaan API tertentu

Anda dapat mengonfigurasi bagian basis kode mana yang akan menjalankan aturan ini, berdasarkan aksesibilitasnya. Misalnya, untuk menentukan bahwa aturan harus berjalan hanya terhadap permukaan API non-publik, tambahkan pasangan kunci-nilai berikut ke file .editorconfig di proyek Anda:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Contoh

Contoh berikut menunjukkan antarmuka kosong.

// Violates rule
public interface IBadInterface
{
}
' Violates rule
Public Interface IBadInterface
End Interface