CA1052: i tipi di supporto statici devono essere Statici o NotInheritable
Proprietà | valore |
---|---|
ID regola | CA1052 |
Titolo | I tipi di supporto statici devono essere Statici o NotInheritable |
Categoria | Progettazione |
Correzione che causa un'interruzione o un'interruzione | Interruzione |
Abilitato per impostazione predefinita in .NET 8 | No |
Causa
Un tipo non astratto contiene solo membri statici (diversi da un possibile costruttore predefinito) e non viene dichiarato con il modificatore statico o condiviso .
Per impostazione predefinita, questa regola esamina solo i tipi visibili esternamente, ma è configurabile.
Descrizione regola
La regola CA1052 presuppone che un tipo che contenga solo membri statici non sia progettato per essere ereditato, perché il tipo non fornisce alcuna funzionalità che può essere sottoposta a override in un tipo derivato. Un tipo che non deve essere ereditato deve essere contrassegnato con il static
modificatore in C# per impedire l'uso come tipo di base. Inoltre, il costruttore predefinito deve essere rimosso. In Visual Basic la classe deve essere convertita in un modulo.
Questa regola non viene attivata per classi o classi astratte con una classe di base. Tuttavia, la regola viene attivata per le classi che supportano un'interfaccia vuota.
Nota
Nell'implementazione più recente dell'analizzatore di questa regola, include anche la funzionalità della regola CA1053.
Come correggere le violazioni
Per correggere una violazione di questa regola, contrassegnare il tipo come static
e rimuovere il costruttore predefinito (C#) o convertirlo in un modulo (Visual Basic).
Quando eliminare gli avvisi
È possibile eliminare le violazioni nei casi seguenti:
- Il tipo è progettato per essere ereditato. L'assenza del
static
modificatore suggerisce che il tipo è utile come tipo di base. - Il tipo viene utilizzato come argomento di tipo. I tipi statici non possono essere usati come argomenti di tipo.
Eliminare un avviso
Se si vuole eliminare una singola violazione, aggiungere direttive del preprocessore al file di origine per disabilitare e quindi riabilitare la regola.
#pragma warning disable CA1052
// The code that's violating the rule is on this line.
#pragma warning restore CA1052
Per disabilitare la regola per un file, una cartella o un progetto, impostarne la gravità none
su nel file di configurazione.
[*.{cs,vb}]
dotnet_diagnostic.CA1052.severity = none
Per altre informazioni, vedere Come eliminare gli avvisi di analisi del codice.
Configurare il codice da analizzare
Usare l'opzione seguente per configurare le parti della codebase in cui eseguire questa regola.
È possibile configurare questa opzione solo per questa regola, per tutte le regole a cui si applica o per tutte le regole in questa categoria (Progettazione) a cui si applica. Per altre informazioni, vedere Opzioni di configurazione delle regole di qualità del codice.
Includere superfici API specifiche
È possibile configurare le parti della codebase in modo da eseguire questa regola in base all'accessibilità. Ad esempio, per specificare che la regola deve essere eseguita solo sulla superficie dell'API non pubblica, aggiungere la coppia chiave-valore seguente a un file con estensione editorconfig nel progetto:
dotnet_code_quality.CAXXXX.api_surface = private, internal
Esempio di violazione
L'esempio seguente mostra un tipo che viola la regola:
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
Correzione con il modificatore statico
L'esempio seguente illustra come correggere una violazione di questa regola contrassegnando il tipo con il static
modificatore in C#:
public static class StaticMembers
{
public static int SomeProperty { get; set; }
public static void SomeMethod() { }
}