CA1707 : Les identificateurs ne doivent pas contenir de traits de soulignement

  • Article
Propriété Value
Identificateur de la règle CA1707
Titre Les identificateurs ne doivent pas contenir de traits de soulignement
Catégorie Dénomination
Le correctif est cassant ou non cassant Cassant - En cas de déclenchement sur des assemblys

Non cassant - En cas de déclenchement sur des paramètres de type
Activé par défaut dans .NET 8 Non

Cause

Le nom d’un identificateur contient le caractère de soulignement (_).

Description de la règle

Par convention, les noms d'identificateurs ne contiennent pas de trait de soulignement (_). Cette règle vérifie les espaces de noms, types, membres et paramètres.

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

Supprimez tous les caractères de soulignement du nom.

Quand supprimer les avertissements

Ne supprimez pas les avertissements pour le code de production. En revanche, vous pouvez sans risque supprimer cet avertissement pour le code de test.

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

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.CA1707.severity = none

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

Pour les méthodes bien connues dans le code Microsoft qui utilisent actuellement un trait de soulignement et ne peuvent pas être modifiées, la règle doit être supprimée.

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