CA1040: Evitare l'utilizzo di interfacce vuote

  • Articolo
Proprietà valore
ID regola CA1040
Titolo Evitare l'uso di interfacce vuote
Categoria Progettazione
Correzione che causa un'interruzione o un'interruzione Interruzione
Abilitato per impostazione predefinita in .NET 8 No

Causa

L'interfaccia non dichiara alcun membro o implementa due o più interfacce.

Per impostazione predefinita, questa regola esamina solo le interfacce visibili esternamente, ma è configurabile.

Descrizione regola

Le interfacce definiscono membri che forniscono un comportamento o un contratto di utilizzo. La funzionalità descritta dall'interfaccia può essere adottata da qualsiasi tipo, indipendentemente dal punto in cui il tipo è visualizzato nella gerarchia di ereditarietà. Un tipo implementa un'interfaccia fornendo implementazioni per i membri dell'interfaccia. Un'interfaccia vuota non definisce alcun membro. Pertanto, non definisce un contratto che può essere implementato.

Se la progettazione include interfacce vuote che i tipi devono implementare, è probabile che si usi un'interfaccia come marcatore o un modo per identificare un gruppo di tipi. Se questa identificazione verrà eseguita in fase di esecuzione, il modo corretto per eseguire questa operazione consiste nell'usare un attributo personalizzato. Usare la presenza o l'assenza dell'attributo o le proprietà dell'attributo per identificare i tipi di destinazione. Se l'identificazione deve verificarsi in fase di compilazione, è accettabile usare un'interfaccia vuota.

Come correggere le violazioni

Rimuovere l'interfaccia o aggiungervi membri. Se l'interfaccia vuota viene usata per etichettare un set di tipi, sostituire l'interfaccia con un attributo personalizzato.

Quando eliminare gli avvisi

È possibile eliminare un avviso da questa regola quando l'interfaccia viene usata per identificare un set di tipi in fase di compilazione.

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

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

Nell'esempio seguente viene illustrata un'interfaccia vuota.

// Violates rule
public interface IBadInterface
{
}

' Violates rule
Public Interface IBadInterface
End Interface