CA1714 : Les noms des enums Flags doivent être au pluriel

  • Article
Propriété Value
Identificateur de la règle CA1714
Titre Les noms des enums Flags doivent être au pluriel
Catégorie Dénomination
Le correctif est cassant ou non cassant Rupture
Activé par défaut dans .NET 8 Non

Cause

Une énumération a le System.FlagsAttribute et son nom et ne se termine pas par 's'.

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

Description de la règle

Les types marqués avec FlagsAttribute ont des noms au pluriel, car l’attribut indique que plusieurs valeurs peuvent être spécifiées. Par exemple, une énumération qui définit les jours de la semaine peut être destinée à être utilisée dans une application où vous pouvez spécifier plusieurs jours. Cette énumération doit avoir le FlagsAttribute et être appelée « Days ». Une énumération similaire qui autorise la spécification d’un seul jour n’aurait pas l’attribut et pourrait être appelée « Day ».

Les conventions de nommage fournissent une recherche commune pour les bibliothèques qui ciblent le common language runtime. Cette cohérence réduit la courbe d’apprentissage requise pour les nouvelles bibliothèques de logiciels et augmente la confiance des clients en ce qui concerne le développement de la bibliothèque par une personne qui a une expertise dans le développement de code managé.

Comment corriger les violations

Faites du nom de l’énumération un mot pluriel ou supprimez l’attribut FlagsAttribute si plusieurs valeurs d’énumération ne doivent pas être spécifiées simultanément.

Quand supprimer les avertissements

Il est sûr de supprimer une infraction si le nom est un mot pluriel, mais ne se termine pas par 's'. Par exemple, si l’énumération à plusieurs jours décrite précédemment était nommée « DaysOfTheWeek », cela enfreindrait la logique de la règle, mais pas son intention. Ces infractions doivent être supprimées.

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

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.CA1714.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 (Nommage) 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