CA1511: ArgumentException スロー ヘルパーを使用する

プロパティ	値
ルール ID	CA1511
Title	ArgumentException スロー ヘルパーを使用する
カテゴリ	保守容易性
修正が中断ありか中断なしか	中断なし
.NET 8 では既定で有効	提案として

原因

コードによって引数が null か空の文字列かをチェックし、条件付きで ArgumentException をスローします。

規則の説明

引数チェックはコード・サイズに大きな影響を及ぼし、小さな関数やプロパティ・セッターのコードを占有することがよくあります。 このようなチェックはインライン化を妨げ、かなりの命令キャッシュ汚染を引き起こします。 ArgumentException.ThrowIfNullOrEmpty(String, String) などのスロー・ヘルパー・メソッドは、新しい例外インスタンスを構築する if ブロックよりもシンプルで効率的です。

例

次のコード スニペットは、CA1511 の違反を示しています。

void M(string arg)
{
    if (string.IsNullOrEmpty(arg))
        throw new ArgumentException("", "arg");
}

次のコード スニペットは修正プログラムを示しています。

void M(string arg)
{
    ArgumentException.ThrowIfNullOrEmpty(arg);
}

違反の修正方法

例外をスローする if ブロックを ArgumentException.ThrowIfNullOrEmpty(String, String) の呼び出しに置き換えます。 または、Visual Studio で Lightbulb メニューを使用して、コードを自動的に修正します。

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

コードの保守性が懸念されない場合は、この規則違反を抑制しても問題ありません。 また、擬陽性であると識別された違反を抑制することもできます。

警告を抑制する

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

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

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

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

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