次の方法で共有

CA2245: プロパティをそれ自体に割り当てません

  • [アーティクル]
プロパティ 値
ルール ID CA2245
Title プロパティをそれ自体に割り当てません
[カテゴリ] 使用方法
修正が中断ありか中断なしか なし
.NET 8 では既定で有効 提案として

原因

プロパティが誤ってそれ自体に割り当てられました。

規則の説明

C# コンパイラは、フィールド、ローカル、またはパラメーター シンボルがそれ自体に割り当てられている場合、警告 CS1717: 同じ変数に割り当てられました。他の変数に割り当てますか? を生成します。 このような誤りは、ローカル、パラメーター、またはフィールド記号の名前がスコープ内の別の記号に似ている場合によく見られます。 割り当ての左側と右側で異なるシンボルを使用するのではなく、両方の側で同じ記号が使用されました。 これにより、値がそれ自体へ冗長に割り当てられ、通常、機能的なバグが示されます。

プロパティをそれ自体に割り当てることは、ほぼすべての実際のケースでも同様の機能のバグになります。 ただし、一部の極端なケースでは、プロパティ値のフェッチによって副作用が生じる可能性があり、プロパティの新しい値が元の値と異なります。 その場合、プロパティの自己割り当ては冗長ではなく、削除することはできません。 これにより、コンパイラは、これらのケースに対して破壊的変更をもたらさずに、プロパティの自己割り当てに対する CS1717 警告を生成できなくなります。

規則 CA2245 は、このギャップを埋めることを目的としています。 これらの機能的なバグを修正できるようにするために、プロパティの自己割り当てに対して違反を報告します。 プロパティの自己割り当てが必要な少数のケースでは、根拠に関する適切なコメントを付けることで CA2245 違反をソースで抑制できます。

違反の修正方法

違反を修正するには、割り当ての左側と右側で異なるシンボルを使用します。 たとえば、次のコード スニペットは、規則の違反とその修正方法を示しています。

public class C
{
    private int p = 0;
    public int P { get; private set; }

    public void M(int p)
    {
        // CS1717: Accidentally assigned the parameter 'p' to itself.
        p = p;

        // CA2245: Accidentally assigned the property 'P' to itself.
        P = P;
    }
}

public class C
{
    private int p = 0;
    public int P { get; private set; }

    public void M(int p)
    {
        // No violation, now the parameter is assigned to the field.
        this.p = p;

        // No violation, now the parameter is assigned to the property.
        P = p;
    }
}

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

プロパティ値のフェッチによって副作用が生じる可能性があり、プロパティの新しい値が元の値と異なる場合、この規則の違反を非表示にすることを推奨します。 その場合、プロパティの自己割り当ては冗長ではありません。 根拠に関するコメントを抑制に追加して、これを想定される動作として文書化する必要があります。

警告を抑制する

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

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

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

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

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

関連項目