CA1005:避免泛型类型的参数过多

属性
规则 ID CA1005
标题 避免泛型类型的参数过多
类别 设计
修复是中断修复还是非中断修复 重大
在 .NET 8 中默认启用

原因

外部可见的泛型类型具有两个以上的类型参数。

默认情况下,此规则仅查看外部可见的类型,但这是可配置的。

规则说明

泛型类型包含的类型参数越多,越难以知道并记住每个类型参数各代表什么。 它通常有一个类型参数,如在 List<T> 中,而在某些情况下有两个类型参数,如在 Dictionary<TKey, TValue> 中。 如果存在两个以上的类型参数,则大多数用户都会感到过于困难(例如 C# 中的 TooManyTypeParameters<T, K, V> 或 Visual Basic 中的 TooManyTypeParameters(Of T, K, V))。

如何解决冲突

若要解决此规则的冲突,请将设计更改为使用不超过两个类型参数。

何时禁止显示警告

除非设计确实需要两个以上的类型参数,否则不要禁止显示此规则的警告。 以易于理解和使用的语法提供泛型,可减少学习所需的时间,并增加新库的采用率。

抑制警告

如果只想抑制单个冲突,请将预处理器指令添加到源文件以禁用该规则,然后重新启用该规则。

#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:使用泛型事件处理程序实例

另请参阅