CA1040:避免使用空接口

项

“值”

RuleId

CA1040

类别

设计

修复是中断修复还是非中断修复

重大

原因

接口不声明任何成员，或实现两个或两个以上其他接口。

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

规则说明

接口定义提供某个行为或使用协定的成员。 接口所描述的功能可以被任何类型采用，而不管该类型出现在继承层次结构中的哪个位置。 类型通过实现接口的成员来实现接口。 空接口不定义任何成员。 因此，它不定义可实现的协定。

如果设计包含期望实现类型的空接口，则可能会将接口用作标记或标识一组类型的方式。 如果在运行时执行此标识，则实现此目的的正确方法是使用自定义特性。 使用或不使用该特性，或使用该特性的属性，以标识目标类型。 如果必须在编译时执行标识，则可以使用空接口。

如何解决冲突

删除接口或向其添加成员。 如果要使用空接口来标记一组类型，请将接口替换为自定义特性。

何时禁止显示警告

当接口用于在编译时标识一组类型时，可以安全地禁止显示此规则的警告。

抑制警告

可以通过多种方式来禁止显示代码分析警告，包括禁用项目的规则、使用预处理器指令为特定代码行禁用该规则或应用 SuppressMessageAttribute 特性。 有关详细信息，请参阅如何禁止显示代码分析警告。

配置代码以进行分析

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

包含特定的 API 图面

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

包含特定的 API 图面

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

dotnet_code_quality.CAXXXX.api_surface = private, internal

示例

下面的示例演示了空接口。

// Violates rule

public interface IBadInterface

{

}

' Violates rule

Public Interface IBadInterface

End Interface