CA1040: Menghindari antarmuka kosong

Penyebab

Antarmuka tidak mendeklarasikan anggota atau mengimplementasikan dua atau beberapa 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, di mana pun jenis tersebut muncul dalam hierarki warisan. Jenis menerapkan antarmuka dengan menyediakan penerapan 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 waktu proses, 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 melabeli sekumpulan jenis, ganti antarmuka dengan atribut kustom.

Kapan harus menekan peringatan

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

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 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 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.

• Menyertakan permukaan API tertentu

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

Contoh

Contoh berikut menunjukkan antarmuka kosong.

// Violates rule
public interface IBadInterface
{
}

' Violates rule
Public Interface IBadInterface
End Interface