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

  • [アーティクル]
プロパティ 値
ルール ID CA1002
Title ジェネリック リストを公開しません
[カテゴリ] デザイン
修正が中断ありか中断なしか あり
.NET 8 では既定で有効 いいえ

原因

型に、System.Collections.Generic.List<T> 型か、List<T> 型を返すか、署名に List<T> パラメーターが含まれている外部から参照できるメンバーが含まれています。

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

規則の説明

System.Collections.Generic.List<T> は、継承ではなくパフォーマンスのために設計されたジェネリック コレクションです。 List<T> には、継承されたクラスの動作の変更を容易にする仮想メンバーが含まれていません。 次のジェネリック コレクションは継承用に設計されているため、List<T> の代わりに公開する必要があります。

違反の修正方法

この規則違反を修正するには、System.Collections.Generic.List<T> 型を継承用に設計されたジェネリック コレクションのいずれかに変更します。

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

この警告を発生させるアセンブリが再利用可能なライブラリを意図していない限り、この規則からの警告を抑制しないでください。 たとえば、ジェネリック リストを使用することでパフォーマンス上の利点が得られたパフォーマンス調整済みのアプリケーションでは、この警告を抑制しても安全です。

警告を抑制する

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

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

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

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

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

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

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

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

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

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

dotnet_code_quality.CAXXXX.api_surface = private, internal

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

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

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

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

関連項目

ジェネリック