Bagikan melalui

CA1714: Bendera enum harus memiliki nama jamak

  • Artikel
Properti Nilai
ID Aturan CA1714
Judul Enum bendera harus memiliki nama jamak
Golongan Penamaan
Perbaikan bersifat disruptif atau non-disruptif Merusak
Diaktifkan secara default di .NET 8 Tidak

Penyebab

Enumerasi memiliki System.FlagsAttribute dan namanya tidak berakhiran 's'.

Secara default, aturan ini hanya melihat enumerasi yang terlihat secara eksternal, tetapi ini dapat dikonfigurasi.

Deskripsi aturan

Jenis yang ditandai dengan FlagsAttribute memiliki nama yang jamak karena atribut menunjukkan bahwa lebih dari satu nilai dapat ditentukan. Misalnya, enumerasi yang menentukan hari dalam seminggu mungkin dimaksudkan untuk digunakan dalam aplikasi tempat Anda dapat menentukan beberapa hari. Enumerasi ini harus memiliki FlagsAttribute dan dapat disebut 'Hari'. Enumerasi serupa yang hanya memungkinkan satu hari untuk ditentukan tidak akan memiliki atribut , dan dapat disebut 'Hari'.

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

Jadikan nama enumerasi sebagai kata jamak, atau hapus FlagsAttribute atribut jika beberapa nilai enumerasi tidak boleh ditentukan secara bersamaan.

Kapan harus menekan peringatan

Aman untuk menekan pelanggaran jika namanya adalah kata jamak tetapi tidak berakhiran 's'. Misalnya, jika enumerasi beberapa hari yang dijelaskan sebelumnya diberi nama 'DaysOfTheWeek', ini akan melanggar logika aturan tetapi bukan niatnya. Pelanggaran tersebut harus ditekan.

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

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

[*.{cs,vb}]
dotnet_diagnostic.CA1714.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.

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

Baca juga