CA1040 : Éviter les interfaces vides

  • Article
Propriété Value
Identificateur de la règle CA1040
Titre Éviter les interfaces vides
Catégorie Conception
Le correctif est cassant ou non cassant Rupture
Activé par défaut dans .NET 8 Non

Cause

L’interface ne déclare aucun membre, ou implémente au moins deux autres interfaces.

Par défaut, cette règle examine uniquement les interfaces visibles en externe, mais elle est configurable.

Description de la règle

Les interfaces définissent des membres qui fournissent un comportement ou un contrat d'utilisation. Les fonctionnalités décrites par l'interface peuvent être adoptées par tout type, indépendamment de l'endroit où le type figure dans la hiérarchie d'héritage. Un type implémente une interface en fournissant des implémentations pour les membres de celle-ci. Une interface vide ne définit aucun membre. Par conséquent, elle ne définit pas de contrat pouvant être implémenté.

Si votre conception inclut des interfaces vides que des types sont censés implémenter, vous utilisez probablement une interface comme marqueur ou comme moyen d’identifier un groupe de types. Si cette identification se produit au moment de l’exécution, la bonne façon de l’effectuer consiste à utiliser un attribut personnalisé. Utilisez la présence ou l’absence de l’attribut, ou les propriétés de l’attribut, pour identifier les types cibles. Si l’identification doit se produire au moment de la compilation, il est acceptable d’utiliser une interface vide.

Comment corriger les violations

Supprimez l’interface ou ajoutez-y des membres. Si l’interface vide est utilisée pour étiqueter un ensemble de types, remplacez l’interface par un attribut personnalisé.

Quand supprimer les avertissements

Vous pouvez sans risque supprimer un avertissement de cette règle lorsque l’interface est utilisée pour identifier un ensemble de types au moment de la compilation.

Supprimer un avertissement

Si vous voulez supprimer une seule violation, ajoutez des directives de préprocesseur à votre fichier source pour désactiver et réactiver la règle.

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

Pour désactiver la règle sur un fichier, un dossier ou un projet, définissez sa gravité sur none dans le fichier de configuration.

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

Pour plus d’informations, consultez Comment supprimer les avertissements de l’analyse de code.

Configurer le code à analyser

Utilisez l’option suivante pour configurer les parties de votre codebase sur lesquelles exécuter cette règle.

Vous pouvez configurer cette option pour cette règle uniquement, pour toutes les règles auxquelles elle s’applique ou pour toutes les règles de cette catégorie (Conception) auxquelles elle s’applique. Pour plus d’informations, consultez Options de configuration des règles de qualité du code.

Inclure des surfaces d’API spécifiques

Vous pouvez configurer les parties de votre codebase sur lesquelles exécuter cette règle, en fonction de leur accessibilité. Par exemple, pour spécifier que la règle doit s’exécuter uniquement sur la surface d’API non publique, ajoutez la paire clé-valeur suivante à un fichier .editorconfig dans votre projet :

dotnet_code_quality.CAXXXX.api_surface = private, internal

Exemple

L’exemple suivant montre une interface vide.

// Violates rule
public interface IBadInterface
{
}

' Violates rule
Public Interface IBadInterface
End Interface