Bagikan melalui

CA1712: Jangan awali nilai enum dengan nama jenis

  • Artikel
Properti Nilai
ID Aturan CA1712
Judul Jangan awali nilai enum dengan nama jenis
Golongan Penamaan
Perbaikan bersifat disruptif atau non-disruptif Merusak
Diaktifkan secara default di .NET 8 Tidak

Penyebab

Enumerasi berisi anggota yang namanya dimulai dengan nama jenis enumerasi.

Deskripsi aturan

Nama anggota enumerasi tidak diawali dengan nama jenis karena informasi jenis diharapkan disediakan oleh alat pengembangan.

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 keyakinan pelanggan bahwa pustaka dikembangkan oleh seseorang yang memiliki keahlian dalam mengembangkan kode terkelola.

Cara memperbaiki pelanggaran

Untuk memperbaiki pelanggaran aturan ini, hapus awalan nama jenis dari anggota enumerasi.

Kapan harus menekan peringatan

Jangan menyembunyikan peringatan dari aturan ini.

Contoh

Contoh berikut menunjukkan enumerasi bernama salah diikuti dengan versi yang dikoreksi.

public enum DigitalImageMode
{
    DigitalImageModeBitmap = 0,
    DigitalImageModeGrayscale = 1,
    DigitalImageModeIndexed = 2,
    DigitalImageModeRGB = 3
}

public enum DigitalImageMode2
{
    Bitmap = 0,
    Grayscale = 1,
    Indexed = 2,
    RGB = 3
}

Imports System

Namespace ca1712

    Enum DigitalImageMode

        DigitalImageModeBitmap = 0
        DigitalImageModeGrayscale = 1
        DigitalImageModeIndexed = 2
        DigitalImageModeRGB = 3

    End Enum

    Enum DigitalImageMode2

        Bitmap = 0
        Grayscale = 1
        Indexed = 2
        RGB = 3

    End Enum

End Namespace

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.

Pemicu awalan nilai enum

Anda dapat mengonfigurasi jumlah nilai enumerasi yang diperlukan untuk memicu aturan. Misalnya, untuk menentukan bahwa aturan dipicu jika satu atau beberapa nilai enum dimulai dengan nama jenis enum, tambahkan pasangan kunci-nilai berikut ke file .editorconfig di proyek Anda:

dotnet_code_quality.CA1712.enum_values_prefix_trigger = AnyEnumValue

Contoh:

Nilai opsi Ringkasan
dotnet_code_quality.CA1712.enum_values_prefix_trigger = AnyEnumValue Aturan dipicu jika salah satu nilai enum dimulai dengan nama jenis enum.
dotnet_code_quality.CA1712.enum_values_prefix_trigger = AllEnumValues Aturan dipicu jika semua nilai enum dimulai dengan nama jenis enum.
dotnet_code_quality.CA1712.enum_values_prefix_trigger = Heuristic Aturan ini dipicu menggunakan heuristik default, yaitu, ketika setidaknya 75% dari nilai enum dimulai dengan nama jenis enum.

Baca juga