CA1822:メンバーを static に設定します

原因

インスタンス データにアクセスしないメンバーは、静的 (Visual Basic では Shared) としてマークされていません。

規則の説明

インスタンス データにアクセスしない、またはインスタンス メソッドを呼び出さないメンバーは、静的 (Visual Basic では Shared) としてマークできます。 メソッドを静的としてマークすると、コンパイラはこれらのメンバーに対する非仮想呼び出しサイトを出力します。 非仮想呼び出しサイトを出力すると、現在のオブジェクト ポインターが null 以外であることを確認する呼び出しごとに実行時にチェックが行われるのを防ぐことができます。 パフォーマンス重視のコードでは、これによりパフォーマンスを大幅に向上できます。 場合によっては、現在のオブジェクト インスタンスにアクセスできないことにより、正確性の問題が発生します。

違反の修正方法

メンバーを静的 (または Visual Basic では Shared) としてマークするか、該当する場合は、メソッド本体で '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");
    }
}

どのようなときに警告を抑制するか

次の場合は、この規則からの警告を抑制しても安全です。

• 修正プログラムが重大な変更となる以前に出荷されたコードの場合。
• MarshalByRefObjectから継承するクラス内のメソッドの場合。 .NET リモート処理インフラストラクチャではインスタンス ディスパッチを使用して AppDomain 境界を越えて呼び出しを転送するため、これらのクラスのメソッドは静的としてマークしないでください。 このようなメソッドを静的にすると、AppDomain の境界を越えてリモート処理が中断される可能性があります。

警告を抑制する

単一の違反を抑制するだけの場合は、ソース ファイルにプリプロセッサ ディレクティブを追加して無効にしてから、規則をもう一度有効にします。

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

ファイル、フォルダー、またはプロジェクトの規則を無効にするには、その重要度を none に設定し、設定ファイル で適用します。

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

詳細については、「コード分析の警告を抑制する方法」を参照してください。

分析するコードを構成する

次のオプションを使用して、コードベースのどの部分に対してこの規則を実行するか構成します。

• 特定の API サーフェイスを含める

このオプションを構成できる対象は、この規則だけ、それを適用するすべての規則、それを適用するこのカテゴリ (パフォーマンス) のすべての規則のいずれかです。 詳細については、「コード品質規則の構成オプション」を参照してください。

特定の API サーフェイスを含める

api_surface オプションを設定することで、アクセスの可否に基づいてこのルールを実行するコードベースの部分を構成できます。 たとえば、非パブリック API サーフェイスでのみ規則を実行するように指定するには、プロジェクトの .editorconfig ファイルに次のキーと値のペアを追加します。

dotnet_code_quality.CAXXXX.api_surface = private, internal

関連規則

• CA1812:インスタンス化されていない内部クラスを使用しません