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

Özellik Değer
Kural Kimliği CA1005
Başlık Genel türlerde aşırı parametre kullanmaktan kaçının
Kategori Tasarım
Düzeltme bozucu ya da bozmayan olabilir Son Dakika
.NET 10'da varsayılan olarak etkin Hayır
Geçerli diller C# ve Visual Basic

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ı

Bir genel tip daha fazla tip parametresi içerdiğinde, her bir tip parametresinin neyi temsil ettiğini bilmek ve hatırlamak daha 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.

Example

// This class violates the rule.
public class TooManyTypeParameters<T, K, V>
{
    public void M1(T t, K k, V v)
    {
        // ...
    }
}

// This class satisfies the rule.
public class CorrectTypeParameters<T, K>
{
    public void M1(T t, K k)
    {
        // ...
    }
}

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

Tasarımın kesin bir şekilde ikiden fazla tür parametresine ihtiyaç duymadığı durumlarda bu kuraldan gelen bir uyarıyı bastırmayın. Genelliklerin anlaşılması ve kullanılmasının kolay olduğu bir söz diziminde sağlanması, öğrenme süresini azaltır ve yeni kütüphanelerin benimsenme 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.

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.

CA1010: Koleksiyonlar genel arabirim uygulamalıdır

CA1000: Genel türlerde statik üyeleri belirtme

CA1002: Genel tipteki listeleri açığa çıkarma

CA1003: Genel olay işleyici örnekleri kullan

Ayrıca bkz.

  • Last updated on