Share via

CA1005:ジェネリック型でパラメーターを使用しすぎないでください

  • [アーティクル]
プロパティ 値
ルール ID CA1005
Title ジェネリック型でパラメーターを使用しすぎないでください
[カテゴリ] デザイン
修正が中断ありか中断なしか あり
.NET 8 では既定で有効 いいえ

原因

外部から参照できるジェネリック型に、3 つ以上の型パラメーターがあります。

既定では、この規則の対象は外部から参照できる型のみですが、これは構成可能です。

規則の説明

ジェネリック型に含まれる型パラメーターが増えれば増えるほど、それぞれの型パラメーターが表す意味を調べることや覚えることが難しくなります。 通常、List<T> のように型パラメーターが 1 つの場合や、Dictionary<TKey, TValue> のように型パラメーターが 2 つの場合には明白です。 型パラメーターが 2 を超えると、ほとんどのユーザーには意味を把握することが困難になります (たとえば、C# のTooManyTypeParameters<T, K, V> や Visual Basic のTooManyTypeParameters(Of T, K, V))。

違反の修正方法

この規則違反を修正するには、2 を超える型パラメーターを使用しないようにデザインを変更します。

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

デザインで 2 を超える型パラメーターがどうしても必要な場合を除き、この規則による警告を抑制しないでください。 わかりやすく使いやすい構文でジェネリックスを提供すると、学習に必要な時間が短縮され、新しいライブラリの採用率が高まります。

警告を抑制する

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

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

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

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

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

分析するコードを構成する

次のオプションを使用して、コードベースのどの部分に対してこの規則を実行するか構成します。

このオプションを構成できる対象は、この規則だけ、それを適用するすべての規則、それを適用するこのカテゴリ (デザイン) のすべての規則のいずれかです。 詳細については、「コード品質規則の構成オプション」を参照してください。

特定の API サーフェイスを含める

ユーザー補助に基づいて、この規則を実行するコードベースの部分を構成できます。 たとえば、非パブリック API サーフェイスでのみ規則を実行するように指定するには、プロジェクトの .editorconfig ファイルに次のキーと値のペアを追加します。

dotnet_code_quality.CAXXXX.api_surface = private, internal

CA1010:コレクションは、ジェネリック インターフェイスを実装しなければなりません

CA1000: ジェネリック型の静的メンバーを宣言しません

CA1002: ジェネリック リストを公開しません

CA1003: 汎用イベント ハンドラーのインスタンスを使用します

関連項目