CA1002:不要公开泛型列表
属性 | 值 |
---|---|
规则 ID | CA1002 |
标题 | 不要公开泛型列表 |
类别 | 设计 |
修复是中断修复还是非中断修复 | 重大 |
在 .NET 9 中默认启用 | 否 |
原因
类型包含外部可见的成员,该成员是 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