Bagikan melalui

CA1717: Hanya enum FlagsAttribute yang boleh memiliki nama jamak

  • Artikel
Properti Nilai
ID Aturan CA1717
Judul Hanya enum FlagsAttribute yang harus memiliki nama jamak
Golongan Penamaan
Perbaikan bersifat disruptif atau non-disruptif Merusak
Diaktifkan secara default di .NET 8 Tidak

Penyebab

Nama enumerasi berakhir dengan kata jamak dan enumerasi tidak ditandai dengan System.FlagsAttribute atribut .

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

Deskripsi aturan

Konvensi penamaan menentukan bahwa nama jamak untuk enumerasi menunjukkan bahwa lebih dari satu nilai enumerasi dapat ditentukan secara bersamaan. FlagsAttribute memberi tahu kompilator bahwa enumerasi harus diperlakukan sebagai bidang bit yang memungkinkan operasi bitwise pada enumerasi.

Jika hanya satu nilai enumerasi yang dapat ditentukan pada satu waktu, nama enumerasi harus berupa kata tunggal. 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. Ini mengurangi waktu yang diperlukan untuk mempelajari pustaka perangkat lunak baru, dan meningkatkan kepercayaan pelanggan bahwa pustaka dikembangkan oleh seseorang yang memiliki keahlian dalam mengembangkan kode terkelola.

Cara memperbaiki pelanggaran

Jadikan nama enumerasi sebagai kata tunggal atau tambahkan FlagsAttribute.

Kapan harus menekan peringatan

Aman untuk menekan peringatan dari aturan jika nama berakhir dengan kata tunggal.

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

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

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