CA1707: Pengidentifikasi tidak boleh berisi garis bawah
| Properti | Nilai |
|---|---|
| ID Aturan | CA1707 |
| Judul | Pengidentifikasi tidak boleh berisi garis bawah |
| Golongan | Penamaan |
| Perbaikan bersifat disruptif atau non-disruptif | Melanggar - ketika dinaikkan pada rakitan Tidak melanggar - saat dinaikkan pada parameter jenis |
| Diaktifkan secara default di .NET 9 | No |
Penyebab
Nama pengidentifikasi berisi karakter garis bawah (_).
Deskripsi aturan
Berdasarkan konvensi, nama pengidentifikasi tidak berisi karakter garis bawah (_). Aturan memeriksa namespace, jenis, anggota, dan parameter.
Konvensi penamaan menyediakan tampilan umum untuk pustaka yang menargetkan runtime bahasa umum. Hal ini mengurangi kurva pembelajaran yang diperlukan untuk pustaka perangkat lunak baru, dan meningkatkan keyakinan pelanggan bahwa pustaka dikembangkan oleh seseorang yang memiliki keahlian dalam mengembangkan kode terkendali.
Cara memperbaiki pelanggaran
Hapus semua karakter garis bawah dari nama.
Kapan harus menekan peringatan
Jangan menekan peringatan untuk kode produksi. Namun, aman untuk menekan peringatan ini untuk kode pengujian.
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 CA1707
// The code that's violating the rule is on this line.
#pragma warning restore CA1707
Untuk menonaktifkan aturan untuk file, folder, atau proyek, atur tingkat keparahannya ke none dalam file konfigurasi.
[*.{cs,vb}]
dotnet_diagnostic.CA1707.severity = none
Untuk informasi selengkapnya, lihat Cara menyembunyikan peringatan analisis kode.
Untuk metode terkenal dalam kode Microsoft yang saat ini menggunakan garis bawah dan tidak dapat dimodifikasi, aturan harus ditekan.
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.
