CA1708: Pengidentifikasi harus berbeda lebih dari sekadar huruf besar-kecil

Properti Nilai
ID Aturan CA1708
Judul Pengidentifikasi harus berbeda lebih dari sekadar perbedaan huruf kapital
Kategori Penamaan
Perbaikan bersifat merusak atau tidak merusak Merusak
Diaktifkan secara default di .NET 10 Tidak
Bahasa yang berlaku C# dan Visual Basic

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 case karena bahasa yang menargetkan common language runtime tidak perlu bersifat case-sensitive. Misalnya, Visual Basic adalah bahasa yang tidak sensitif pada penggunaan huruf besar/kecil yang banyak digunakan.

Cara memperbaiki pelanggaran

Pilih nama yang unik jika dibandingkan dengan pengidentifikasi-pengidentifikasi lain dengan cara yang tidak membedakan huruf besar dan 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.

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

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;
}