CA1708: Pengidentifikasi harus berbeda dengan lebih dari kasus

Artikel
09/06/2023

Properti	Nilai
ID Aturan	CA1708
Judul	Pengidentifikasi harus berbeda selain dari huruf kapital
Golongan	Penamaan
Perbaikan bersifat disruptif atau non-disruptif	Merusak
Diaktifkan secara default di .NET 8	Tidak

Penyebab

Nama dua jenis, anggota, parameter, atau namespace yang sepenuhnya memenuhi syarat identik saat dikonversi ke huruf kecil.

Secara default, aturan ini hanya melihat jenis, anggota, dan namespace yang terlihat secara eksternal, tetapi ini dapat dikonfigurasi.

Deskripsi aturan

Pengidentifikasi untuk namespace, jenis, anggota, dan parameter tidak dapat berbeda hanya berdasarkan huruf besar/kecil karena bahasa yang menargetkan runtime bahasa umum tidak perlu peka huruf besar/kecil. Misalnya, Visual Basic adalah bahasa yang tidak peka huruf besar/kecil yang banyak digunakan.

Cara memperbaiki pelanggaran

Pilih nama yang unik jika dibandingkan dengan pengidentifikasi lain dengan cara yang tidak peka huruf besar/kecil.

Kapan harus menekan peringatan

Jangan menyembunyikan peringatan dari aturan ini. Pustaka mungkin tidak dapat digunakan dalam semua bahasa yang tersedia di .NET.

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 (Penamaan) yang diterapkannya. Untuk informasi selengkapnya, lihat Opsi konfigurasi aturan kualitas kode.

Menyertakan permukaan API tertentu

Anda dapat mengonfigurasi bagian mana dari basis kode yang akan menjalankan aturan ini, berdasarkan aksesibilitasnya. 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 pelanggaran

Contoh berikut menunjukkan pelanggaran aturan ini.

public class Class1
{
    protected string someName;
    public string SomeName => someName;
}

Contoh berikut menunjukkan salah satu cara untuk memperbaiki pelanggaran

public class Class1
{
    protected string _someName;
    public string SomeName => _someName;
}

Bagikan melalui