CA1052: Statische Containertypen müssen „Static“ oder „NotInheritable“ sein.

  • Artikel
Eigenschaft Wert
Regel-ID CA1052
Titel Statische Containertypen müssen Static oder NotInheritable sein
Kategorie Design
Fix führt oder führt nicht zur Unterbrechung Breaking
Standardmäßig in .NET 8 aktiviert Nein

Ursache

Ein nicht abstrakter Typ enthält nur statische Member (mit Ausnahme eines möglichen Standardkonstruktors) und ist nicht mit dem Static oder Shared-Modifizierer deklariert.

Standardmäßig werden mit dieser Regel nur extern sichtbare Typen überprüft, aber dies ist konfigurierbar.

Regelbeschreibung

Regel CA1052 geht davon aus, dass ein Typ, der nur statische Member enthält, nicht für die Vererbung konzipiert ist, da dieser Typ keine Funktionen bereitstellt, die in einem abgeleiteten Typ überschrieben werden können. Ein Typ, der nicht vererbt werden soll, sollte mit dem static-Modifizierer in C# markiert werden, um seine Verwendung als Basistyp zu verhindern. Außerdem sollte der Standardkonstruktor entfernt werden. In Visual Basic sollte die Klasse in ein Modul konvertiert werden.

Diese Regel wird für abstrakte Klassen oder Klassen, die über eine Basisklasse verfügen, nicht ausgelöst. Die Regel wird jedoch für Klassen ausgelöst, die eine leere Schnittstelle unterstützen.

Hinweis

In der neuesten Analysetool-Implementierung dieser Regel ist auch die Funktionalität von Regel CA1053 enthalten.

Behandeln von Verstößen

Um einen Verstoß gegen diese Regel zu beheben, markieren Sie den Typ als static und entfernen Sie den Standardkonstruktor (C#), oder konvertieren Sie ihn in ein Modul (Visual Basic).

Wann sollten Warnungen unterdrückt werden?

Sie können Verstöße in den folgenden Fällen unterdrücken:

  • Der Typ ist für die Vererbung konzipiert. Das Fehlen des static Modifizierers deutet darauf hin, dass der Typ als Basistyp nützlich ist.
  • Der Typ kann nicht als Typargument verwendet werden. Statische Typen können nicht als Typargumente verwendet werden.

Unterdrücken einer Warnung

Um nur eine einzelne Verletzung zu unterdrücken, fügen Sie der Quelldatei Präprozessoranweisungen hinzu, um die Regel zu deaktivieren und dann wieder zu aktivieren.

#pragma warning disable CA1052
// The code that's violating the rule is on this line.
#pragma warning restore CA1052

Um die Regel für eine Datei, einen Ordner oder ein Projekt zu deaktivieren, legen Sie den Schweregrad in der Konfigurationsdatei auf none fest.

[*.{cs,vb}]
dotnet_diagnostic.CA1052.severity = none

Weitere Informationen finden Sie unter Vorgehensweise: Unterdrücken von Codeanalyse-Warnungen.

Konfigurieren des zu analysierenden Codes

Mithilfe der folgenden Option können Sie konfigurieren, für welche Teile Ihrer Codebasis diese Regel ausgeführt werden soll.

Sie können diese Optionen nur für diese Regel, für alle zutreffenden Regeln oder für alle zutreffenden Regeln in dieser Kategorie (Entwurf) konfigurieren. Weitere Informationen finden Sie unter Konfigurationsoptionen für die Codequalitätsregel.

Einschließen bestimmter API-Oberflächen

Sie können je nach Zugänglichkeit festlegen, für welche Bestandteile Ihrer Codebasis diese Regel ausgeführt wird. Sie können beispielsweise festlegen, dass die Regel nur für die nicht öffentliche API-Oberfläche ausgeführt werden soll, indem Sie einer EDITORCONFIG-Datei in Ihrem Projekt das folgende Schlüssel-Wert-Paar hinzufügen:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Beispiel für einen Verstoß

Das folgende Beispiel zeigt einen Typ, der gegen die Regel verstößt:

public class StaticMembers
{
    public static int SomeProperty { get; set; }
    public static void SomeMethod() { }
}

Imports System

Namespace ca1052

    Public Class StaticMembers

        Shared Property SomeProperty As Integer

        Private Sub New()
        End Sub

        Shared Sub SomeMethod()
        End Sub

    End Class

End Namespace

Behebung mit dem statischen Modifizierer

Das folgende Beispiel zeigt, wie Sie einen Verstoß gegen diese Regel beheben, indem Sie den Typ mit dem static-Modifizierer in C# markieren:

public static class StaticMembers
{
    public static int SomeProperty { get; set; }
    public static void SomeMethod() { }
}