CA1513:使用 ObjectDisposedException 擲回協助程式
屬性 | 值 |
---|---|
規則識別碼 | CA1513 |
標題 | 使用 ObjectDisposedException 擲回協助程式 |
類別 | 可維護性 |
修正程式是中斷或非中斷 | 非中斷 |
預設在 .NET 8 中啟用 | 建議 |
原因
程式碼會檢查物件是否已處置,然後有條件地擲回 ObjectDisposedException 。
檔案描述
物件檢查會對程式碼大小產生重大影響,而且通常會主宰小型函式和屬性 setter 的程式碼。 這些檢查可防止內嵌並造成大量指令快取污染。 擲回協助程式方法,例如 ThrowIf 比 if
建構新例外狀況實例的區塊更簡單且更有效率。
範例
下列程式碼片段顯示 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
如需詳細資訊,請參閱 如何隱藏程式碼分析警告 。