Bagikan melalui

CA2217: Jangan tandai enum dengan FlagsAttribute

  • Artikel
Properti Nilai
ID Aturan CA2217
Judul Jangan tandai enum dengan FlagsAttribute
Golongan Penggunaan
Perbaikan bersifat disruptif atau non-disruptif Non-disruptif
Diaktifkan secara default di .NET 9 No

Penyebab

Enumerasi ditandai dengan FlagsAttribute dan memiliki satu atau beberapa nilai yang bukan kekuatan dua atau kombinasi dari nilai lain yang ditentukan pada enumerasi.

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

Deskripsi aturan

Enumerasi seharusnya FlagsAttribute hanya ada jika setiap nilai yang ditentukan dalam enumerasi adalah kekuatan dua atau kombinasi nilai yang ditentukan.

Cara memperbaiki pelanggaran

Untuk memperbaiki pelanggaran aturan ini, hapus FlagsAttribute dari enumerasi.

Kapan harus menekan peringatan

Jangan menyembunyikan peringatan dari aturan ini.

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 (Penggunaan) 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.

Contoh

Kode berikut menunjukkan enumerasi, Color, yang berisi nilai 3. 3 bukan kekuatan dua, atau kombinasi dari salah satu nilai yang ditentukan. Enumerasi Color tidak boleh ditandai dengan FlagsAttribute.

// Violates this rule    
[FlagsAttribute]
public enum Color
{
    None = 0,
    Red = 1,
    Orange = 3,
    Yellow = 4
}

Imports System

Namespace Samples

    ' Violates this rule    
    <FlagsAttribute()> _
    Public Enum Color

        None = 0
        Red = 1
        Orange = 3
        Yellow = 4

    End Enum
End Namespace

Kode berikut menunjukkan enumerasi, Days, yang memenuhi persyaratan untuk ditandai dengan FlagsAttribute:

[FlagsAttribute]
public enum Days
{
    None = 0,
    Monday = 1,
    Tuesday = 2,
    Wednesday = 4,
    Thursday = 8,
    Friday = 16,
    All = Monday | Tuesday | Wednesday | Thursday | Friday
}

Imports System
Namespace Samples

    <FlagsAttribute()> _
    Public Enum Days

        None = 0
        Monday = 1
        Tuesday = 2
        Wednesday = 4
        Thursday = 8
        Friday = 16
        All = Monday Or Tuesday Or Wednesday Or Thursday Or Friday

    End Enum
End Namespace

CA1027: Tandai enum dengan FlagsAttribute

Lihat juga