CA1040: Vyhněte se prázdným rozhraním

  • Článek
Vlastnost Hodnota
ID pravidla CA1040
Název Vyhněte se prázdným rozhraním
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

Rozhraní deklaruje žádné členy ani neimplementuje dvě nebo více dalších rozhraní.

Ve výchozím nastavení toto pravidlo sleduje jenom externě viditelná rozhraní, ale dá se konfigurovat.

Popis pravidla

Rozhraní definují členy ujednávající jejich chování nebo užití. Funkčnost popsaná rozhraním může být osvojena libovolným typem bez ohledu na to, kde se typ vyskytuje v hierarchii dědičnosti. Typ implementuje rozhraní tím, že poskytuje implementace jeho členů. Prázdné rozhraní nedefinuje žádné členy. Proto nedefinuje kontrakt, který lze implementovat.

Pokud návrh obsahuje prázdná rozhraní, která se mají implementovat, pravděpodobně používáte rozhraní jako značku nebo způsob, jak identifikovat skupinu typů. Pokud k této identifikaci dojde za běhu, správným způsobem, jak toho dosáhnout, je použít vlastní atribut. Pomocí přítomnosti nebo nepřítomnosti atributu nebo vlastností atributu identifikujte cílové typy. Pokud k identifikaci musí dojít v době kompilace, je přijatelné použít prázdné rozhraní.

Jak opravit porušení

Odeberte rozhraní nebo do něj přidejte členy. Pokud se prázdné rozhraní používá k označení sady typů, nahraďte rozhraní vlastním atributem.

Kdy potlačit upozornění

Pokud se rozhraní používá k identifikaci sady typů v době kompilace, je bezpečné potlačit upozornění z tohoto pravidla.

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

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

Následující příklad ukazuje prázdné rozhraní.

// Violates rule
public interface IBadInterface
{
}

' Violates rule
Public Interface IBadInterface
End Interface