CA1822 : Marquer les membres comme statique

Propriété Valeur
Identificateur de la règle CA1822
Titre Marquez les membres comme static
Catégorie Performance
Le correctif a un effet disruptif ou non disruptif Non décisif : si le membre n’est pas visible en dehors de l'assemblage, quelle que soit la modification que vous apportez.

Non rupture - Si vous remplacez simplement le membre par un membre d’instance avec le mot clé this.

Modification majeure : Si vous changez le membre d’un membre d’instance à un membre statique et qu’il est visible en dehors de l’*assembly*.
Activé par défaut dans .NET 10 À titre de suggestion
Langues applicables C# et Visual Basic

Cause

Un membre qui n’accède pas aux données d’instance n’est pas marqué comme static (Shared en Visual Basic).

Description de la règle

Les membres qui n’accèdent pas aux données d’instance ou n’appellent pas de méthodes d’instance peuvent être marqués comme static (Shared en Visual Basic). Une fois que les méthodes ont été marquées comme static, le compilateur émet des sites d'appel non virtuels vers ces membres. L’émission de sites d’appels non virtuels empêche une vérification au moment de l’exécution pour chaque appel qui garantit que le pointeur d’objet actuel n’est pas nul. Cette opération peut se traduire par un gain de performances mesurable pour le code dépendant des performances. Dans certains cas, l’échec d’accès à l’instance d’objet actuelle représente un problème d’exactitude.

Comment corriger les violations

Marquez le membre comme static (ou Shared en Visual Basic) ou utilisez 'this'/'Me' dans le corps de la méthode, le cas échéant.

Example

public class Printer
{
    private readonly List<char> _items = [
        'H', 'e', 'l', 'l', 'o',
    ];

    public void PrintHello()
    {
        BadPrintHelloInternal();
        GoodPrintHelloInternal();
        GoodPrintHelloStaticInternal();
    }

    // This method violates the rule.
    private void BadPrintHelloInternal()
    {
        Console.WriteLine("Hello");
    }

    // This methods satisfies the rule.
    private void GoodPrintHelloInternal()
    {
        Console.WriteLine(string.Join(string.Empty, this._items));
    }

    private static void GoodPrintHelloStaticInternal()
    {
        Console.WriteLine("Hello");
    }
}

Quand supprimer les avertissements

Il est sûr de supprimer un avertissement de cette règle dans les cas suivants :

  • Pour le code déjà livré où le correctif constituerait un changement majeur.
  • Pour les méthodes dans les classes qui héritent de MarshalByRefObject. Les méthodes de ces classes ne doivent pas être marquées comme statiques, car l’infrastructure de communication à distance .NET utilise la distribution d’instances pour transférer des appels au-delà des limites AppDomain. Rendre ces méthodes statiques peut interrompre la communication à distance entre différents domaines d'application AppDomain.

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

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.CA1822.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 (Performances) 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é, en définissant l'option api_surface. 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

Remarque

Remplacez la partie XXXX de CAXXXX par l’ID de la règle applicable.

  • Last updated on