CA1501: Aşırı devralmadan kaçın

Neden

Tür, devralma hiyerarşisinde beş veya daha fazla düzeydir.

Kural açıklaması

İç içe yuvalanmış hiyerarşileri izlemek, anlamak ve muhafaza etmek zor olabilir. Bu kural, analizi aynı modüldeki hiyerarşilerle sınırlar.

Bu kuralı aşağıdaki yollarla yapılandırabilirsiniz:

• Varsayılan olarak, kural türleri ad alanının dışında System tutar. Kuralı diğer türleri veya ad alanlarını da dışlamak için yapılandırabilirsiniz.
• Bu kuralın tetiklendiği devralma ağacı derinliğini yapılandırabilirsiniz.

İhlalleri düzeltme

Bu kuralın ihlalini düzeltmek için, türü devralma hiyerarşisinde daha az derin olan bir temel türden türetin veya ara temel türlerden bazılarını ortadan kaldırın.

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

Bu kuraldan gelen bir uyarıyı engellemek güvenlidir. Ancak, kodu korumak daha zor olabilir. Temel türlerin görünürlüğüne bağlı olarak, bu kuralın ihlallerini çözmek hataya neden olan değişikliklere neden olabilir. Örneğin, genel temel türleri kaldırmak hataya neden olan bir değişikliktir.

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

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.CA1501.severity = none

Daha fazla bilgi için bkz . Kod analizi uyarılarını gizleme.

Eşiği yapılandırma

Bu kuralın tetiklendiği eşiği yapılandırabilirsiniz.

1. CodeMetricsConfig.txt adlı bir metin dosyası oluşturun.

2. İstenen eşiği metin dosyasına aşağıdaki biçimde ekleyin:

   CA1501: 8
   

   Bu örnekte kural, bir tür devralma hiyerarşisinde sekiz veya daha fazla düzey derin olduğunda tetiklenen şekilde yapılandırılır.

3. Proje dosyasında yapılandırma dosyasının derleme eylemini AdditionalFiles olarak işaretleyin. Örneğin:

   <ItemGroup>
     <AdditionalFiles Include="CodeMetricsConfig.txt" />
   </ItemGroup>
   

Çö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.

• Devralma dışlanan tür veya ad alanı adları

Bu seçeneği yalnızca bu kural, geçerli olduğu tüm kurallar veya bu kategorideki (Bakım) tüm kurallar için yapılandırabilirsiniz. Daha fazla bilgi için bkz . Kod kalitesi kuralı yapılandırma seçenekleri.

Devralma dışlanan tür veya ad alanı adları

Kuralı, devralma hiyerarşi ağacından belirli türleri veya ad alanlarını dışlamak üzere yapılandırabilirsiniz. Varsayılan olarak, ad alanından System.* tüm türler dışlanır. Hangi değeri ayarlarsanız ayarlayın, bu varsayılan değer eklenir.

Örnek

Aşağıdaki örnekte kuralı ihlal eden bir tür gösterilmektedir:

class BaseClass {}
class FirstDerivedClass : BaseClass {}
class SecondDerivedClass : FirstDerivedClass {}
class ThirdDerivedClass : SecondDerivedClass {}
class FourthDerivedClass : ThirdDerivedClass {}

// This class violates the rule.
class FifthDerivedClass : FourthDerivedClass {}

Imports System

Namespace ca1501

    Class BaseClass
    End Class

    Class FirstDerivedClass
        Inherits BaseClass
    End Class

    Class SecondDerivedClass
        Inherits FirstDerivedClass
    End Class

    Class ThirdDerivedClass
        Inherits SecondDerivedClass
    End Class

    Class FourthDerivedClass
        Inherits ThirdDerivedClass
    End Class

    ' This class violates the rule.
    Class FifthDerivedClass
        Inherits FourthDerivedClass
    End Class

End Namespace