CA1043 : Utiliser un argument de chaîne ou intégral pour les indexeurs

  • Article
Propriété Value
Identificateur de la règle CA1043
Titre Utiliser un argument de chaîne ou intégral pour les indexeurs
Catégorie Conception
Le correctif est cassant ou non cassant Rupture
Activé par défaut dans .NET 8 Non

Cause

Un type contient un indexeur qui utilise un type d’index autre que System.Int32, System.Int64, System.Object ou System.String.

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

Description de la règle

Les indexeurs, c’est-à-dire les propriétés indexées, doivent utiliser des types entiers ou chaîne pour l’index. Ces types sont généralement utilisés pour indexer des structures de données et accroître la facilité d’utilisation de la bibliothèque. L’utilisation du type Object doit se restreindre aux cas où le type entier ou chaîne spécifique ne peut pas être spécifié au moment du design. Si la conception nécessite d’autres types pour l’index, vérifiez si le type représente un magasin de données logique. S’il ne représente pas un magasin de données logique, utilisez une méthode.

Comment corriger les violations

Pour corriger une violation de cette règle, remplacez l’index par un type entier ou chaîne, ou utilisez une méthode au lieu de l’indexeur.

Quand supprimer les avertissements

Supprimez un avertissement de cette règle uniquement après avoir soigneusement examiné la nécessité de l’indexeur non standard.

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

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

Exemple

L’exemple suivant montre un indexeur qui utilise un index Int32.

string[] Month = new string[] { "Jan", "Feb", "..." };

public string this[int index]
{
    get => Month[index];
}

Private month() As String = {"Jan", "Feb", "..."}

Default ReadOnly Property Item(index As Integer) As String
    Get
        Return month(index)
    End Get
End Property