CA1005: Genel türlerde aşırı parametrelerden kaçının

  • Makale
Özellik Değer
Kural Kimliği CA1005
Başlık Genel türlerde aşırı parametre kullanmaktan kaçının
Kategori Tasarım
Hataya neden olan veya bozulmayan düzeltme Yeni
.NET 8'de varsayılan olarak etkin Hayır

Neden

Dışarıdan görünen genel bir türün ikiden fazla türü parametresi vardır.

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

Kural açıklaması

Daha çok tip parametresi, genel tip içerir, bilmek daha zordur ve hangi tip parametrelerinin temsil ettiğini anımsamak zordur. genellikle içinde olduğu gibi List<T>bir tür parametresiyle ve bazı durumlarda da içinde olduğu gibi Dictionary<TKey, TValue>iki tür parametresiyle açıktır. İkiden fazla tür parametresi varsa, zorluk çoğu kullanıcı için çok büyük olur (örneğin, TooManyTypeParameters<T, K, V> C# veya TooManyTypeParameters(Of T, K, V) Visual Basic'te).

İhlalleri düzeltme

Bu kuralın ihlalini düzeltmek için tasarımı en fazla iki tür parametre kullanacak şekilde değiştirin.

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

Tasarım kesinlikle ikiden fazla tür parametresi gerektirmediği sürece bu kuraldan bir uyarıyı bastırmayın. Genel değerlerin anlaşılması ve kullanımı kolay bir söz diziminde sağlanması, öğrenmesi gereken süreyi azaltır ve yeni kitaplıkların benimseme oranını artırır.

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

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.CA1005.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

CA1010: Koleksiyonlar genel arabirim uygulamalıdır

CA1000: Genel türlerde statik üyeleri belirtme

CA1002: Genel listeleri gösterme

CA1003: Genel olay işleyici örnekleri kullan

Ayrıca bkz.