共用方式為

CA1512：使用 ArgumentOutOfRangeException 擲回協助程式

  • 發行項
屬性 值
規則識別碼 CA1512
職稱 使用 ArgumentOutOfRangeException 擲回協助程式
類別 可維護性
修正程式是中斷或非中斷 非中斷
預設在 .NET 9 中啟用 建議

原因

程式代碼會檢查自變數是否小於或大於指定的值，然後有條件地擲回 ArgumentOutOfRangeException。

檔案描述

自變數檢查會對程式碼大小產生重大影響，而且通常會主宰小型函式和屬性 setter 的程式代碼。 這些檢查可防止內嵌並造成大量指令快取污染。 擲回協助程式方法，例如 ArgumentOutOfRangeException.ThrowIfGreaterThan 比 if 建構新例外狀況實例的區塊更簡單且更有效率。

範例

下列代碼段顯示 CA1512 違規：

void M(int arg)
{
    if (arg is 0)
        throw new ArgumentOutOfRangeException(nameof(arg));
    if (arg < 0)
        throw new ArgumentOutOfRangeException(nameof(arg));
    if (arg <= 0)
        throw new ArgumentOutOfRangeException(nameof(arg));
    if (arg <= 42)
        throw new ArgumentOutOfRangeException(nameof(arg));
    if (arg < 42)
        throw new ArgumentOutOfRangeException(nameof(arg));
    if (arg > 42)
        throw new ArgumentOutOfRangeException(nameof(arg));
    if (arg >= 42)
        throw new ArgumentOutOfRangeException(nameof(arg));
    if (arg == 42)
        throw new ArgumentOutOfRangeException(nameof(arg));
    if (arg != 42)
        throw new ArgumentOutOfRangeException(nameof(arg));
}

下列代碼段顯示修正：

void M(int arg)
{
    ArgumentOutOfRangeException.ThrowIfZero(arg);
    ArgumentOutOfRangeException.ThrowIfNegative(arg);
    ArgumentOutOfRangeException.ThrowIfNegativeOrZero(arg);
    ArgumentOutOfRangeException.ThrowIfLessThanOrEqual(arg, 42);
    ArgumentOutOfRangeException.ThrowIfLessThan(arg, 42);
    ArgumentOutOfRangeException.ThrowIfGreaterThan(arg, 42);
    ArgumentOutOfRangeException.ThrowIfGreaterThanOrEqual(arg, 42);
    ArgumentOutOfRangeException.ThrowIfEqual(arg, 42);
    ArgumentOutOfRangeException.ThrowIfNotEqual(arg, 42);
}

如何修正違規

if將擲回例外狀況的 區塊取代為下列其中一個 throw-helper 方法的呼叫：

或者，在Visual Studio中，使用燈泡菜單自動修正程序代碼。

隱藏警告的時機

如果您不擔心程式代碼的可維護性，則隱藏此規則的違規是安全的。 您也可以隱藏識別為誤判的違規行為。

隱藏警告

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

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

若要停用檔案、資料夾或項目的規則，請在組態檔中將其嚴重性設定為 。none

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

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