CA1707: Pengidentifikasi tidak boleh berisi garis bawah

Properti Nilai
ID Aturan CA1707
Judul Pengidentifikasi tidak boleh berisi tanda garis bawah
Kategori Penamaan
Perbaikan bersifat merusak atau tidak merusak Pecah - saat diangkat pada rakitan

Tidak melanggar - saat dinaikkan pada parameter jenis
Diaktifkan secara default di .NET 10 Tidak
Bahasa yang berlaku C# dan Visual Basic

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 keseragaman tampilan untuk pustaka yang menargetkan common language runtime. 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.

Example

// This code violates the rule.
namespace ca_1707
{
    public interface IUser_Service
    {
        void Add_User(User_Model user_Model);
    }

    public class User_Service : IUser_Service
    {
        public const string Admin_Name = "admin";
        public event EventHandler? User_Added;

        public void Add_User(User_Model user_Model)
        {
            // ...
        }
    }

    public struct User_Model
    {
        public int User_Id { get; set; }
    }

    public enum User_Type
    {
        Client_User = 0,
        Manager_Admin = 1,
        Syper_Admin = 3,
    }
}

Kapan harus menekan peringatan

Jangan mengabaikan peringatan untuk kode produksi. Namun, tidak masalah 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 underscore dan tidak dapat dimodifikasi, aturan tersebut harus dikecualikan.

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.

  • Last updated on