CA1712: Numaralandırma değerleri için tür adıyla önek kullanmayın

  • Makale
Özellik Değer
Kural Kimliği CA1712
Başlık Sabit listesi değerlerine tür adını önek olarak eklemeyin
Kategori Adlandırma
Hataya neden olan veya bozulmayan düzeltme Yeni
.NET 8'de varsayılan olarak etkin Hayır

Neden

Numaralandırma, adı numaralandırmanın tür adıyla başlayan bir üye içerir.

Kural açıklaması

Tür bilgilerinin geliştirme araçları tarafından sağlanması beklendiğinden, numaralandırma üyelerinin adları tür adıyla ön eklenmez.

Adlandırma kuralları, ortak dil çalışma zamanını hedefleyen kitaplıklar için ortak bir görünüm sağlar. Bu, yeni bir yazılım kitaplığını öğrenmek için gereken süreyi azaltır ve kitaplığın yönetilen kod geliştirme konusunda uzmanlığı olan biri tarafından geliştirildiğine dair müşteri güvenini artırır.

İhlalleri düzeltme

Bu kuralın ihlalini düzeltmek için, sabit listesi üyesinden tür adı ön ekini kaldırın.

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

Bu kuraldan uyarıyı bastırmayın.

Örnek

Aşağıdaki örnekte yanlış adlandırılmış bir numaralandırma ve ardından düzeltilmiş sürüm gösterilmektedir.

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

Çö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 (Adlandırma) tüm kurallar için yapılandırabilirsiniz. Daha fazla bilgi için bkz . Kod kalitesi kuralı yapılandırma seçenekleri.

Numaralandırma değerleri ön eki tetikleyicisi

Kuralı tetikleme için gereken numaralandırma değerlerinin sayısını yapılandırabilirsiniz. Örneğin, bir veya daha fazla sabit listesi değeri sabit listesi türü adıyla başlarsa kuralın tetikleneceğini belirtmek için projenizdeki bir .editorconfig dosyasına aşağıdaki anahtar-değer çiftini ekleyin:

dotnet_code_quality.CA1712.enum_values_prefix_trigger = AnyEnumValue

Örnekler:

Seçenek değeri Özet
dotnet_code_quality.CA1712.enum_values_prefix_trigger = AnyEnumValue Sabit listesi değerlerinden herhangi biri sabit listesi türü adıyla başlıyorsa, kural tetikler.
dotnet_code_quality.CA1712.enum_values_prefix_trigger = AllEnumValues Tüm sabit listesi değerleri sabit listesi türü adıyla başlıyorsa, kural tetikler.
dotnet_code_quality.CA1712.enum_values_prefix_trigger = Heuristic Kural, sabit listesi değerlerinin en az %75'i sabit listesi türü adıyla başladığında varsayılan buluşsal yöntemler kullanılarak tetikler.

Ayrıca bkz.