CA1058: Türler belli temel türleri genişletmemelidir

Özellik Değer
Kural Kimliği CA1058
Başlık Türler belirli temel türleri aşmamalıdır
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

Bir tür aşağıdaki temel türlerden birini genişletir:

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ı

Özel durumlar System ad alanındaki System.Exception veya onun alt sınıflarından türetilmelidir.

Temel alınan bir nesne modelinin veya veri kaynağının XML görünümünü oluşturmak istiyorsanız, XmlDocument sınıfının alt sınıfını oluşturmayın.

Genel olmayan koleksiyonlar

Mümkün olduğunda genel koleksiyonları kullanın ve/veya genişletin. Daha önce dağıtımını yapmadıysanız kodunuzda genel olmayan koleksiyonları genişletmeyin.

Yanlış Kullanım Örnekleri

public class MyCollection : CollectionBase
{
}

public class MyReadOnlyCollection : ReadOnlyCollectionBase
{
}

Doğru Kullanım Örnekleri

public class MyCollection : Collection<T>
{
}

public class MyReadOnlyCollection : ReadOnlyCollection<T>
{
}

İhlalleri düzeltme

Bu kuralın ihlalini düzeltmek için türü farklı bir temel türden veya genel bir koleksiyondan türetin.

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

hakkında ApplicationException ihlalleri için bu kuraldan gelen bir uyarıyı bastırmayın. XmlDocument hakkında ihlaller için bu kuraldan gelen bir uyarıyı engellemek güvenlidir. Kod daha önce yayımlandıysa, genel olmayan bir koleksiyonla ilgili bir uyarıyı bastırmak 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 CA1058
// The code that's violating the rule is on this line.
#pragma warning restore CA1058

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

  • Last updated on