CA1717: Yalnızca FlagsAttribute numaralandırmalarında çoğul adlar olmalıdır

  • Makale
Özellik Değer
Kural Kimliği CA1717
Başlık Yalnızca FlagsAttribute sabit listeleri çoğul adlara sahip olmalıdır
Kategori Adlandırma
Hataya neden olan veya bozulmayan düzeltme Yeni
.NET 8'de varsayılan olarak etkin Hayır

Neden

Sabit listesi adı çoğul sözcükle biter ve numaralandırma özniteliğiyle System.FlagsAttribute işaretlenmez.

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ı

Adlandırma kuralları, bir sabit listesi için çoğul adın aynı anda birden fazla sabit listesi değeri belirtilebileceğini belirtir. derleyicilerine FlagsAttribute numaralandırmanın sabit listesi üzerinde bit düzeyinde işlemleri etkinleştiren bir bit alanı olarak ele alınması gerektiğini bildirir.

Bir numaralandırmanın tek seferde yalnızca bir değeri belirtilebiliyorsa, numaralandırmanın adı tek bir sözcük olmalıdır. Örneğin, haftanın günlerini tanımlayan bir numaralandırma, birden çok gün belirtebileceğiniz bir uygulamada kullanıma yönelik olabilir. Bu numaralandırmada FlagsAttribute ve bulunmalıdır ve 'Days' olarak adlandırılabilir. Yalnızca tek bir günün belirtilmesine izin veren benzer bir numaralandırma özniteliğine sahip değildir ve 'Day' olarak adlandırılabilir.

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

Numaralandırmanın adını tekil bir sözcük yapın veya ekleyin FlagsAttribute.

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

Ad tekil bir sözcükle bitiyorsa kuraldan gelen bir uyarıyı engellemek güvenlidir.

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

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.CA1717.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 (Adlandırma) 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

Ayrıca bkz.