CA1047 : Ne pas déclarer les membres protégés dans les types sealed

  • Article
Propriété Value
Identificateur de la règle CA1047
Titre Ne pas déclarer les membres protégés dans les types sealed
Catégorie Conception
Le correctif est cassant ou non cassant Sans rupture
Activé par défaut dans .NET 8 À titre de suggestion

Cause

Un type public est sealed (NotInheritable en Visual Basic) et déclare un membre protégé ou un type imbriqué protégé. Cette règle ne signale pas les violations pour les méthodes Finalize, qui doivent suivre ce modèle.

Description de la règle

Les types déclarent des membres protégés afin que des types qui héritent puissent accéder au membre ou le substituer. Par définition, vous ne pouvez pas hériter d’un type sealed, ce qui signifie que les méthodes protégées sur les types sealed ne peuvent pas être appelées.

Le compilateur C# émet un avertissement CS0628 au lieu de CA1047 pour cette situation.

Comment corriger les violations

Pour corriger une violation de cette règle, modifiez le niveau d’accès du membre sur « privé » ou rendez le type héritable.

Quand supprimer les avertissements

Ne supprimez aucun avertissement de cette règle. Laisser le type dans son état actuel peut entraîner des problèmes de maintenance et n’offre aucun avantage.

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 un type qui enfreint cette règle.

public sealed class SealedClass
{
    protected void ProtectedMethod(){}
}

Public NotInheritable Class BadSealedType
    Protected  Sub MyMethod
    End Sub
End Class