Sdílet prostřednictvím

CA1822: Označte členy jako statické

Vlastnost Hodnota
ID pravidla CA1822
Název Označte členy jako statické
Kategorie Výkon
Oprava způsobující chybu nebo chybu způsobující chybu Nerozbití – Pokud není člen viditelný mimo sestavení, bez ohledu na změnu, kterou provedete.

Nerozbití – Pokud pouze změníte člena na člena instance s klíčovým slovem this .

Přerušení – Pokud změníte člena z člena instance na statický člen a je viditelný mimo sestavení.
Povoleno ve výchozím nastavení v .NET 10 Jako návrh

Příčina

Člen, který nepřistupuje k datům instance, není označený jako statický (sdílený v jazyce Visual Basic).

Popis pravidla

Členy, kteří nepřistupují k datům instance nebo metodám volání instance, lze označit jako statické (sdílené v jazyce Visual Basic). Po označení metod jako statických bude kompilátor generovat těmto členům nevirtuální místa volání. Generování nevirtuálních míst volání zabrání kontrole během běhu programu při každém volání, která musí ověřit, že aktuální ukazatel objektu není nulový. To může dosáhnout měřitelného zvýšení výkonu pro kód citlivý na výkon. V některých případech představuje chyba přístupu k aktuální instanci objektu problém správnosti.

Jak opravit porušení

Pokud je to vhodné, označte člena jako statický (nebo sdílený v jazyce Visual Basic) nebo v textu metody použijte "this"/'Me".

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");
    }
}

Kdy potlačit upozornění

Je bezpečné potlačit upozornění z tohoto pravidla pro dříve expedovaný kód, pro který by oprava byla zásadní změnou.

Potlačení upozornění

Pokud chcete pouze potlačit jedno porušení, přidejte do zdrojového souboru direktivy preprocesoru, abyste pravidlo zakázali a znovu povolili.

#pragma warning disable CA1822
// The code that's violating the rule is on this line.
#pragma warning restore CA1822

Pokud chcete pravidlo pro soubor, složku nebo projekt zakázat, nastavte jeho závažnost v none konfiguračním souboru.

[*.{cs,vb}]
dotnet_diagnostic.CA1822.severity = none

Další informace naleznete v tématu Jak potlačit upozornění analýzy kódu.

Konfigurace kódu pro analýzu

Pomocí následující možnosti nakonfigurujte, ve kterých částech základu kódu se má toto pravidlo spouštět.

Tuto možnost můžete nakonfigurovat jenom pro toto pravidlo, pro všechna pravidla, která platí, nebo pro všechna pravidla v této kategorii (Výkon), na která platí. Další informace naleznete v tématu Možnosti konfigurace pravidla kvality kódu.

Zahrnutí konkrétních povrchů rozhraní API

Nastavením možnosti api_surface můžete nakonfigurovat, na kterých částech základu kódu se má toto pravidlo spouštět na základě jejich přístupnosti. Pokud chcete například určit, že pravidlo by se mělo spouštět jenom na neveřejné ploše rozhraní API, přidejte do souboru .editorconfig v projektu následující pár klíč-hodnota:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Poznámka

Nahraďte XXXX část CAXXXX ID příslušného pravidla.

  • Last updated on