CA1027: Enum türlerini FlagsAttribute ile işaretle

Özellik Değer
Kural Kimliği CA1027
Başlık Enumları FlagsAttribute ile işaretleyin
Kategori Tasarım
Düzeltme bozucu ya da bozmayan olabilir Kesintisiz
.NET 10'da varsayılan olarak etkin Hayır
Geçerli diller C# ve Visual Basic

Neden

Sabit listesi değerleri, iki'nin kuvvetleri veya sabit listede tanımlanan diğer değerlerin birleşimleridir ve System.FlagsAttribute özniteliği yoktur. Hatalı pozitif sonuçları azaltmak için, bu kural bitişik değerlere sahip numaralandırmalar için bir ihlal bildirmez.

Varsayılan olarak, bu kural yalnızca dışarıdan görünen numaralandırmalara bakar, ancak bu yapılandırılabilir.

Kural açıklaması

Bir numaralandırma ilişkili adlandırılmış sabitler kümesini tanımlayan değer türüdür. Adlandırılmış sabitleri anlamlı bir şekilde birleştirilebildiğinde bir numaralandırmaya uygulayın FlagsAttribute . Örneğin, hangi günün kaynaklarının kullanılabilir olduğunu takip eden bir uygulamada haftanın günlerinin numaralandırmasını düşünün. Eğer her kaynağın mevcudiyeti, FlagsAttribute içeren numaralandırma kullanılarak kodlanıyorsa, günlerin herhangi bir kombinasyonu temsil edilebilir. özniteliği olmadan, haftanın yalnızca bir günü temsil edilebilir.

Birleşebilir numaralandırmaları depolayan alanlar için, tek tek numaralandırma değerleri alanda bit grupları olarak işlenir. Bu nedenle, bu tür alanlar bazen bit alanları olarak adlandırılır. Bit alanındaki depolama için numaralandırma değerlerini birleştirmek için Boole koşullu işleçlerini kullanın. Belirli bir sabit listesi değerinin mevcut olup olmadığını belirlemek üzere bir bit alanını test etmek için Boole mantıksal işleçlerini kullanın. Bir bit alanının birleştirilmiş numaralandırma değerlerini doğru bir şekilde depolaması ve alması için, numaralandırmada tanımlanan her değerin iki güçte olması gerekir. Bu olmadığı sürece, Boole mantıksal işleçleri alanda depolanan tek tek numaralandırma değerlerini ayıklayamaz.

İhlalleri düzeltme

Bu kuralın ihlalini düzeltmek için numaralandırmaya ekleyin FlagsAttribute .

Uyarıların ne zaman bastırılması gerekiyor?

Numaralandırma değerlerinin birleştirilebilir olmasını istemiyorsanız, bu kuraldan bir uyarıyı gizleyin.

Uyarıyı gizleme

Yalnızca tek bir ihlali engellemek istiyorsanız, kuralı devre dışı bırakmak ve sonra yeniden etkinleştirmek için kaynak dosyanıza ön işlemci yönergeleri ekleyin.

#pragma warning disable CA1027
// The code that's violating the rule is on this line.
#pragma warning restore CA1027

Bir dosya, klasör veya projenin kuralını devre dışı bırakmak için, yapılandırma dosyasındaki önem derecesini noneolarak ayarlayın.

[*.{cs,vb}]
dotnet_diagnostic.CA1027.severity = none

Daha fazla bilgi için bkz . Kod analizi uyarılarını gizleme.

Kod çözümleme için konfigüre et

Bu kuralın kod tabanınızın hangi bölümlerinde çalıştırılacaklarını yapılandırmak için aşağıdaki seçeneği kullanın.

Bu seçeneği yalnızca bu kural, geçerli olduğu tüm kurallar veya bu kategorideki (Tasarım) tüm kurallar için yapılandırabilirsiniz. Daha fazla bilgi için bkz . Kod kalitesi kuralı yapılandırma seçenekleri.

Belirli API yüzeylerini ekleme

api_surface seçeneğini ayarlayarak, bu kuralın erişilebilirliği temelinde kod tabanınızın hangi bölümlerinde çalıştırılacaklarını yapılandırabilirsiniz. Örneğin, kuralın yalnızca genel olmayan API yüzeyinde çalıştırılması gerektiğini belirtmek için projenizdeki bir .editorconfig dosyasına aşağıdaki anahtar-değer çiftini ekleyin:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Not

XXXX CAXXXX bölümünü geçerli kuralın kimliğiyle değiştirin.

Örnek

Aşağıdaki örnekte, DaysEnumNeedsFlags kullanma FlagsAttribute gereksinimlerini karşılayan ancak buna sahip olmayan bir numaralandırmadır. Numaralandırma ColorEnumShouldNotHaveFlag, iki'nin kuvvetleri olan değerlere sahip değildir ancak yanlışlıkla FlagsAttribute belirtir. Bu, CA2217 kuralını ihlal eder: Enum'ları FlagsAttribute ile işaretlemeyin.

// Violates rule: MarkEnumsWithFlags.
public enum DaysEnumNeedsFlags
{
    None = 0,
    Monday = 1,
    Tuesday = 2,
    Wednesday = 4,
    Thursday = 8,
    Friday = 16,
    All = Monday | Tuesday | Wednesday | Thursday | Friday
}

// Violates rule: DoNotMarkEnumsWithFlags.
[FlagsAttribute]
public enum ColorEnumShouldNotHaveFlag
{
    None = 0,
    Red = 1,
    Orange = 3,
    Yellow = 4
}

Ayrıca bkz.

  • Last updated on