CA1005 : Éviter les paramètres excessifs sur les types génériques

  • Article
Propriété Value
Identificateur de la règle CA1005
Titre Éviter les paramètres excessifs sur les types génériques
Catégorie Conception
Le correctif est cassant ou non cassant Rupture
Activé par défaut dans .NET 8 Non

Cause

Un type générique visible en externe a plus de deux paramètres de type.

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

Description de la règle

Plus un type générique contient de paramètres de type, plus il est difficile de déterminer et de mémoriser la représentation de chaque paramètre de type. Cela est généralement évident avec un paramètre de type, comme dans List<T>, et dans certains cas avec deux paramètres de type, comme dans Dictionary<TKey, TValue>. S’il existe plus de deux paramètres de type, la difficulté devient trop grande pour la plupart des utilisateurs (par exemple, TooManyTypeParameters<T, K, V> en C# ou TooManyTypeParameters(Of T, K, V) en Visual Basic).

Comment corriger les violations

Pour corriger une violation de cette règle, modifiez la conception pour qu’elle n’utilise pas plus de deux paramètres de type.

Quand supprimer les avertissements

Ne supprimez pas d’avertissement de cette règle, sauf si la conception nécessite absolument plus de deux paramètres de type. La fourniture de génériques dans une syntaxe facile à comprendre et à utiliser réduit le temps nécessaire à l’apprentissage et augmente le taux d’adoption des nouvelles bibliothèques.

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

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

CA1010 : Les collections doivent implémenter une interface générique

CA1000 : Ne pas déclarer de membres statiques sur les types génériques

CA1002 : N’exposez pas de listes génériques

CA1003 : Utiliser les instances du gestionnaire d’événements génériques

Voir aussi