CA1002: Genel listeleri gösterme

Özellik Değer
Kural Kimliği CA1002
Başlık Genel listeleri açıkta bırakma
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

Tür, dışarıdan görünür olan, bir System.Collections.Generic.List<T> türü içeren, bir List<T> türünü döndüren veya imzasında bir List<T> parametresi bulunan bir üyeye sahipse.

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ı

System.Collections.Generic.List<T> devralma için değil performans için tasarlanmış genel bir koleksiyondur. List<T> devralınan bir sınıfın davranışını değiştirmeyi kolaylaştıran sanal üyeler içermez. Aşağıdaki genel koleksiyonlar devralma için tasarlanmıştır ve List<T> yerine kullanılmalıdır.

İhlalleri düzeltme

Bu kuralın ihlalini düzeltmek için System.Collections.Generic.List<T> türünü, devralma için tasarlanmış genel koleksiyonlardan biriyle değiştirin.

Example

// This class violates the rule.
public class MutableItems
{
    // CA1002: Change 'List<string>' in 'MutableItems.Items' to
    // use 'Collection<T>', 'ReadOnlyCollection<T>' or 'KeyedCollection<K,V>'.
    public List<string> Items { get; } = [];

    public void Add(string item)
    {
        Items.Add(item);
    }
}

// This class satisfies the rule.
public class ReadOnlyItems
{
    private readonly List<string> _items = [];

    public IReadOnlyCollection<string> Items => _items.AsReadOnly();

    public void Add(string item)
    {
        _items.Add(item);
    }
}

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

Bu uyarıyı oluşturan derlemenin yeniden kullanılabilir bir kitaplık olması amaçlanmadığı sürece bu kuraldan gelen bir uyarıyı bastırmayın. Örneğin, genel listelerin kullanımından bir performans avantajının elde edildiği performans ayarlı bir uygulamada bu uyarıyı gizlemeniz güvenli olacaktı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 CA1002
// The code that's violating the rule is on this line.
#pragma warning restore CA1002

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

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

CA1010: Koleksiyonlar genel arabirim uygulamalıdır

CA1000: Genel türlerde statik üyeleri belirtme

CA1003: Genel olay işleyici örnekleri kullan

Ayrıca bkz.

Generics

  • Last updated on