CA1070 : Ne pas déclarer de champs d’événement comme virtuels

  • Article
Propriété Value
Identificateur de la règle CA1070
Titre Ne pas déclarer de champs d’événement comme virtuels
Catégorie Conception
Le correctif est cassant ou non cassant Rupture
Activé par défaut dans .NET 8 Comme suggestion

Cause

Un événement de type champ a été déclaré comme virtuel.

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

Description de la règle

Suivez ces instructions de conception .NET pour déclencher des événements de classe de base dans des classes dérivées. Ne déclarez pas d’événements virtuels dans une classe de base. Les événements substitués dans une classe dérivée ont un comportement non défini. Le compilateur C# ne gère pas ceci correctement, et il n’est pas possible de prévoir si un abonné à l’événement dérivé s’abonnera à l’événement de classe de base.

using System;
public class C
{
    // CA1070: Event 'ThresholdReached' should not be declared virtual.
    public virtual event EventHandler ThresholdReached;
}

Comment corriger les violations

Suivez ces instructions de conception .NET et évitez les événements de type champ virtuel.

Quand supprimer les avertissements

Si l’événement est une API publique visible en externe qui fait déjà partie d’une bibliothèque livrée, vous pouvez sans risque supprimer un avertissement de cette règle afin d’éviter un changement cassant pour les consommateurs de bibliothèque.

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

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

Voir aussi