CA1028: Numaralandırma depolaması Int32 olmalıdır

  • Makale
Özellik Değer
Kural Kimliği CA1028
Başlık Sabit listesi depolaması Int32 olmalıdır
Kategori Tasarım
Hataya neden olan veya bozulmayan düzeltme Yeni
.NET 8'de varsayılan olarak etkin Hayır

Neden

Numaralandırmanın temel türü değildir System.Int32.

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. Varsayılan olarak, System.Int32 sabit değeri depolamak için veri türü kullanılır. Bu temel türü değiştirebilmenize rağmen, çoğu senaryo için gerekli değildir veya önerilmez. değerinden küçük Int32bir veri türü kullanılarak önemli bir performans kazancı elde edile yoktur. Varsayılan veri türünü kullanamıyorsanız, numaralandırmanın tüm değerlerinin CLS uyumlu programlama dillerinde temsil edilediğinden emin olmak için Ortak Dil Sistemi (CLS) uyumlu tam sayı türlerinden ByteInt16birini , , Int32veya Int64 kullanmanız gerekir.

İhlalleri düzeltme

Boyut veya uyumluluk sorunları yoksa, bu kuralın ihlalini düzeltmek için kullanın Int32. Değerleri barındıracak kadar büyük olmayan durumlarda Int32 kullanın Int64. Geriye dönük uyumluluk daha küçük bir veri türü gerektiriyorsa veya Int16kullanınByte.

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

Yalnızca geriye dönük uyumluluk sorunları gerektirdiğinde bu kuraldan gelen bir uyarıyı bastırır. Uygulamalarda, bu kurala uyulmaması genellikle sorunlara neden olmaz. Dil birlikte çalışabilirliğinin gerekli olduğu kitaplıklarda, bu kurala uymamak kullanıcılarınızı olumsuz etkileyebilir.

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

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.CA1028.severity = none

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

Çözümlemek için kod yapılandırma

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

Bu kuralın üzerinde çalıştırılacak kod tabanınızın hangi bölümlerini erişilebilirliklerine göre 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

Örnek

Aşağıdaki örnekte, önerilen temel alınan veri türünü kullanmayan iki numaralandırma gösterilmektedir.

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

public enum Color : sbyte
{
    None = 0,
    Red = 1,
    Orange = 3,
    Yellow = 4
}

<Flags()>
Public Enum Days As UInteger
    None = 0
    Monday = 1
    Tuesday = 2
    Wednesday = 4
    Thursday = 8
    Friday = 16
    All = Monday Or Tuesday Or Wednesday Or Thursday Or Friday
End Enum

Public Enum Color As SByte
    None = 0
    Red = 1
    Orange = 3
    Yellow = 4
End Enum

Aşağıdaki örnek, temel alınan veri türünü Int32olarak değiştirerek önceki ihlali düzeltir.

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

public enum Color : int
{
    None = 0,
    Red = 1,
    Orange = 3,
    Yellow = 4
}

<Flags()>
Public Enum Days As Integer
    None = 0
    Monday = 1
    Tuesday = 2
    Wednesday = 4
    Thursday = 8
    Friday = 16
    All = Monday Or Tuesday Or Wednesday Or Thursday Or Friday
End Enum

Public Enum Color As Integer
    None = 0
    Red = 1
    Orange = 3
    Yellow = 4
End Enum

Ayrıca bkz.