CA1513:使用 ObjectDisposedException 拋出輔助工具

屬性
規則識別碼 CA1513
職稱 使用 ObjectDisposedException 的擲回輔助器
類別 可維護性
修正是造成中斷還是不中斷 非中斷
在 .NET 10 中預設啟用 作為建議
適用語言 C# 與 Visual Basic

原因

程式代碼會檢查物件是否已處置,然後有條件地擲回 ObjectDisposedException

規則描述

物件檢查會對程式代碼大小產生重大影響,而且通常會主宰小型函式和屬性 setter 的程式代碼。 這些檢查可防止內嵌並造成大量指令快取記憶體污染。 拋出輔助方法,例如 ThrowIfif 建構新例外狀況實例的區塊更簡單且更有效率。

範例

下列代碼段顯示 CA1513 的違規:

class C
{
    private bool _disposed = false;
    void M()
    {
        if (_disposed)
            throw new ObjectDisposedException(GetType().Name);
    }
}

下列代碼段顯示修正:

class C
{
    private bool _disposed = false;
    void M()
    {
        ObjectDisposedException.ThrowIf(_disposed, this);
    }
}

如何修正違規

將擲回例外狀況的if區塊替換為ThrowIf的呼叫。 或者,在Visual Studio中,使用燈泡菜單自動修正程序代碼。

隱藏警告的時機

如果您不擔心程式代碼的可維護性,則隱藏此規則的違規是安全的。 您也可以抑制確定為誤報的違規行為。

隱藏警告

如果您只想要隱藏單一違規,請將預處理器指示詞新增至原始程式檔以停用,然後重新啟用規則。

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

若要停用檔案、資料夾或專案的規則,請在組態檔中將其嚴重性設為 none

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

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