CA1716: Pengidentifikasi tidak boleh cocok dengan kata kunci

Penyebab

Nama namespace, jenis, atau anggota virtual atau antarmuka cocok dengan kata kunci yang dipesan dalam bahasa pemrograman.

Secara default, aturan ini hanya melihat namespace, jenis, dan anggota yang terlihat secara eksternal, tetapi Anda dapat mengonfigurasi visibilitas dan jenis simbol.

Deskripsi aturan

Pengidentifikasi untuk namespace, jenis, dan anggota virtual dan antarmuka tidak boleh cocok dengan kata kunci yang ditentukan oleh bahasa yang menargetkan runtime bahasa umum. Tergantung pada bahasa yang digunakan dan kata kunci, kesalahan pengkompilasi dan ambiguitas dapat membuat pustaka sulit digunakan.

Aturan ini memeriksa terhadap kata kunci dalam bahasa berikut:

• Visual Basic
• C#
• C++/CLI

Perbandingan yang tidak peka huruf besar/kecil digunakan untuk kata kunci Visual Basic, dan perbandingan peka huruf besar/kecil digunakan untuk bahasa lain.

Cara memperbaiki pelanggaran

Pilih nama yang tidak muncul dalam daftar kata kunci.

Kapan harus menekan peringatan

Anda dapat menekan peringatan dari aturan ini jika Anda yakin bahwa pengidentifikasi tidak akan membingungkan pengguna API, dan bahwa pustaka dapat digunakan dalam semua bahasa yang tersedia di .NET.

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 CA1716
// The code that's violating the rule is on this line.
#pragma warning restore CA1716

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

[*.{cs,vb}]
dotnet_diagnostic.CA1716.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
• Jenis simbol yang dianalisis

Anda dapat mengonfigurasi opsi ini hanya untuk aturan ini, untuk semua aturan yang berlaku, atau untuk semua aturan dalam kategori ini (Penamaan) yang berlaku untuk aturan tersebut. 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

Jenis simbol yang dianalisis

Anda dapat mengonfigurasi jenis simbol yang akan dianalisis oleh aturan ini. Nilai yang diizinkan adalah:

• Namespace
• NamedType
• Method
• Property
• Event
• Parameter

Pisahkan beberapa nilai dengan koma (,). Nilai default mencakup semua jenis simbol dalam daftar sebelumnya.

dotnet_code_quality.CA1716.analyzed_symbol_kinds = Namespace, NamedType, Method, Property, Event