CA1716 : Les identificateurs ne doivent pas correspondre à des mots clés

Cause

Le nom d’un espace de noms, d’un type ou d’un membre virtuel ou d’interface correspond à un mot clé réservé dans un langage de programmation.

Par défaut, cette règle n’examine que les espaces de noms, les types et les membres visibles en externe, mais vous pouvez configurer la visibilité et les types de symboles.

Description de la règle

Les identificateurs des espaces de noms, des types et des membres virtuels et d’interface ne doivent pas correspondre aux mots clés définis par les langages qui ciblent le Common Language Runtime. Selon le langage utilisé et le mot clé, les erreurs et ambiguïtés du compilateur peuvent rendre l’utilisation de la bibliothèque difficile.

Cette règle vérifie les mots clés dans les langages suivants :

• Visual Basic
• C#
• C++/CLI

La comparaison sans respect de la casse est utilisée pour les mots clés Visual Basic, et la comparaison respectant la casse dans les autres langages.

Comment corriger les violations

Sélectionnez un nom qui n’apparaît pas dans la liste des mots clés.

Quand supprimer les avertissements

Vous pouvez supprimer un avertissement de cette règle si vous avez la certitude que l’identificateur ne confond pas les utilisateurs de l’API et que la bibliothèque est utilisable dans tous les langages disponibles dans .NET.

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

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

• Inclure des surfaces d’API spécifiques
• Types de symboles analysés

Vous pouvez configurer ces options pour cette règle uniquement, pour toutes les règles auxquelles elles s’appliquent ou pour toutes les règles de cette catégorie (Nommage) auxquelles elles s’appliquent. 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

Types de symboles analysés

Vous pouvez configurer les types de symboles qui seront analysés par cette règle. Les valeurs autorisées sont les suivantes :

• Namespace
• NamedType
• Method
• Property
• Event
• Parameter

Séparez les valeurs par des virgules (,). La valeur par défaut inclut tous les types de symboles de la liste précédente.

dotnet_code_quality.CA1716.analyzed_symbol_kinds = Namespace, NamedType, Method, Property, Event