分享方式:


CA2245:請勿將屬性指派給屬性自身

屬性
規則識別碼 CA2245
標題 請勿將屬性指派給屬性自身
類別 使用方式
修正程式是中斷或非中斷 不中斷
預設在 .NET 8 中啟用 建議

原因

不小心將屬性指派給本身。

檔案描述

C# 編譯器會產生警告 CS1717:指派給相同的變數;您的意思是指派別的東西嗎? 當欄位、本機或參數符號指派給本身時。 當區域、參數或欄位符號的名稱類似于範圍中的另一個符號時,這類錯誤很常見。 在指派的左側和右側不使用不同的符號,而是在兩側使用相同的符號。 這會導致值的備援指派給本身,而且通常表示功能錯誤。

針對幾乎所有真實世界案例,將屬性指派給本身也是類似的功能錯誤。 不過,在某些極端的角落案例中,擷取屬性值可能會有副作用,而且屬性的新值與原始值不同。 如果是,則屬性自我指派不是多餘的,而且無法移除。 這可防止編譯器針對屬性自我指派產生 CS1717 警告,而不會針對這些案例引入重大變更。

規則 CA2245 旨在填補這一空白。 它會報告屬性自我指派的違規,以協助修正這些功能 Bug。 對於需要屬性自我指派的一小組邊角案例, 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

如需詳細資訊,請參閱 如何隱藏程式碼分析警告

另請參閱