CA1058:类型不应扩展某些基类型

属性	值
规则 ID	CA1058
标题	类型不应扩展某些基类型
类别	设计
修复是中断修复还是非中断修复	重大
在 .NET 8 中默认启用	否

原因

类型扩展了以下基类型之一：

• System.ApplicationException
• System.Xml.XmlDocument
• System.Collections.CollectionBase
• System.Collections.DictionaryBase
• System.Collections.Queue
• System.Collections.ReadOnlyCollectionBase
• System.Collections.SortedList
• System.Collections.Stack

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

规则说明

异常应派生自 System.Exception 或其在 System 命名空间中的子类之一。

如果要创建基础对象模型或数据源的 XML 视图，请勿创建 XmlDocument 的子类。

非泛型集合

尽可能使用和/或扩展泛型集合。 除非之前已发布过代码，否则请勿在代码中扩展非泛型集合。

错误用法示例

public class MyCollection : CollectionBase
{
}

public class MyReadOnlyCollection : ReadOnlyCollectionBase
{
}

正确用法示例

public class MyCollection : Collection<T>
{
}

public class MyReadOnlyCollection : ReadOnlyCollection<T>
{
}

如何解决冲突

若要解决此规则的冲突，请从其他基类型或泛型集合派生该类型。

何时禁止显示警告

对于有关 ApplicationException 的冲突，请勿禁止显示此规则的警告。 对于有关 XmlDocument 的冲突，可以安全地禁止显示此规则的警告。 如果之前发布过代码，则可以安全地禁止显示有关非泛型集合的警告。

抑制警告

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

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

若要对文件、文件夹或项目禁用该规则，请在配置文件中将其严重性设置为 none。

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

有关详细信息，请参阅如何禁止显示代码分析警告。

配置代码以进行分析

使用下面的选项来配置代码库的哪些部分要运行此规则。

• 包含特定的 API 图面

可以仅为此规则、为适用的所有规则或为适用的此类别（设计）中的所有规则配置此选项。 有关详细信息，请参阅代码质量规则配置选项。

包含特定的 API 图面

你可以根据代码库的可访问性，配置要针对其运行此规则的部分。 例如，若要指定规则应仅针对非公共 API 图面运行，请将以下键值对添加到项目中的 .editorconfig 文件：

dotnet_code_quality.CAXXXX.api_surface = private, internal