CA1052: Statické typy držitelů by měly být Statické nebo NotInheritable
Vlastnost | Hodnota |
---|---|
ID pravidla | CA1052 |
Název | Statické typy držáků by měly být Statické nebo NotInheritable |
Kategorie | Návrh |
Oprava způsobující chybu nebo chybu způsobující chybu | Narušující |
Povoleno ve výchozím nastavení v .NET 8 | No |
Příčina
Ne abstraktní typ obsahuje pouze statické členy (kromě možného výchozího konstruktoru) a není deklarován pomocí statického nebo sdíleného modifikátoru.
Ve výchozím nastavení toto pravidlo sleduje jenom externě viditelné typy, ale dá se konfigurovat.
Popis pravidla
Pravidlo CA1052 předpokládá, že typ, který obsahuje pouze statické členy, není navržen tak, aby byl zděděný, protože typ neposkytuje žádné funkce, které lze přepsat v odvozeného typu. Typ, který nemá být zděděn, by měl být označen modifikátorem static
v jazyce C#, aby se zakázalo jeho použití jako základní typ. Kromě toho by se měl odebrat jeho výchozí konstruktor. V jazyce Visual Basic by se třída měla převést na modul.
Toto pravidlo se neaktivuje pro abstraktní třídy nebo třídy, které mají základní třídu. Pravidlo se však aktivuje pro třídy, které podporují prázdné rozhraní.
Poznámka:
V nejnovější implementaci tohoto pravidla zahrnuje také funkce pravidla CA1053.
Jak opravit porušení
Pokud chcete opravit porušení tohoto pravidla, označte typ jako static
výchozí konstruktor (C#) nebo ho převeďte na modul (Visual Basic).
Kdy potlačit upozornění
Porušení můžete potlačit v následujících případech:
- Typ je navržený tak, aby byl zděděný. Absence modifikátoru
static
naznačuje, že typ je užitečný jako základní typ. - Typ se používá jako argument typu. Statické typy nelze použít jako argumenty typu.
Potlačení upozornění
Pokud chcete pouze potlačit jedno porušení, přidejte do zdrojového souboru direktivy preprocesoru, abyste pravidlo zakázali a znovu povolili.
#pragma warning disable CA1052
// The code that's violating the rule is on this line.
#pragma warning restore CA1052
Pokud chcete pravidlo pro soubor, složku nebo projekt zakázat, nastavte jeho závažnost v none
konfiguračním souboru.
[*.{cs,vb}]
dotnet_diagnostic.CA1052.severity = none
Další informace naleznete v tématu Jak potlačit upozornění analýzy kódu.
Konfigurace kódu pro analýzu
Pomocí následující možnosti nakonfigurujte, ve kterých částech základu kódu se má toto pravidlo spouštět.
Tuto možnost můžete nakonfigurovat jenom pro toto pravidlo, pro všechna pravidla, která platí, nebo pro všechna pravidla v této kategorii (Návrh), na která platí. Další informace naleznete v tématu Možnosti konfigurace pravidla kvality kódu.
Zahrnutí konkrétních povrchů rozhraní API
Na základě přístupnosti můžete nakonfigurovat, na kterých částech základu kódu se má toto pravidlo spouštět. Pokud chcete například určit, že pravidlo by se mělo spouštět jenom na neveřejné ploše rozhraní API, přidejte do souboru .editorconfig v projektu následující pár klíč-hodnota:
dotnet_code_quality.CAXXXX.api_surface = private, internal
Příklad porušení
Následující příklad ukazuje typ, který porušuje pravidlo:
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
Oprava pomocí statického modifikátoru
Následující příklad ukazuje, jak opravit porušení tohoto pravidla tím, že typ označíte modifikátorem static
v jazyce C#:
public static class StaticMembers
{
public static int SomeProperty { get; set; }
public static void SomeMethod() { }
}