CA1040: 空のインターフェイスは使用しないでください
| プロパティ | 値 |
|---|---|
| ルール ID | CA1040 |
| Title | 空のインターフェイスは使用しません |
| [カテゴリ] | デザイン |
| 修正が中断ありか中断なしか | あり |
| .NET 8 では既定で有効 | いいえ |
原因
インターフェイスで、メンバーが宣言されていないか、2 つ以上の他のインターフェイスを実装していません。
既定では、この規則の対象は外部から参照可能なインターフェイスのみですが、これは構成可能です。
規則の説明
インターフェイスには、動作や使用のコントラクトを実現するメンバーが定義されます。 インターフェイスで示される機能は、継承の階層構造内に型が存在するかどうかにかかわらず、どの型からも適用できます。 型ではインターフェイスのメンバーに実装することで、インターフェイスが実装されます。 空のインターフェイスではメンバーが定義されません。 そのため、実装できるコントラクトも定義されません。
型に実装する必要がある空のインターフェイスが設計に含まれている場合は、インターフェイスをマーカーまたは型のグループを識別する方法として使用している可能性があります。 この識別が実行時に行われる場合、これを完遂する正しい方法は、カスタム属性を使用することです。 対象の型を特定するには、属性の有無、または属性のプロパティを使用します。 コンパイル時に識別を行うが必要がある場合は、空のインターフェイスを使用できます。
違反の修正方法
インターフェイスを削除するか、またはそのインターフェイスにメンバーを追加します。 型のセットのラベル付けに空のインターフェイスが使用されている場合は、インターフェイスをカスタム属性に置き換えます。
どのようなときに警告を抑制するか
コンパイル時に型のセットを識別するためにインターフェイスが使用されている場合は、この規則からの警告を表示しないようにしても問題ありません。
警告を抑制する
単一の違反を抑制するだけの場合は、ソース ファイルにプリプロセッサ ディレクティブを追加して無効にしてから、規則をもう一度有効にします。
#pragma warning disable CA1040
// The code that's violating the rule is on this line.
#pragma warning restore CA1040
ファイル、フォルダー、またはプロジェクトの規則を無効にするには、構成ファイルでその重要度を none に設定します。
[*.{cs,vb}]
dotnet_diagnostic.CA1040.severity = none
詳細については、「コード分析の警告を抑制する方法」を参照してください。
分析するコードを構成する
次のオプションを使用して、コードベースのどの部分に対してこの規則を実行するか構成します。
このオプションを構成できる対象は、この規則だけ、それを適用するすべての規則、それを適用するこのカテゴリ (デザイン) のすべての規則のいずれかです。 詳細については、「コード品質規則の構成オプション」を参照してください。
特定の API サーフェイスを含める
ユーザー補助に基づいて、この規則を実行するコードベースの部分を構成できます。 たとえば、非パブリック API サーフェイスでのみ規則を実行するように指定するには、プロジェクトの .editorconfig ファイルに次のキーと値のペアを追加します。
dotnet_code_quality.CAXXXX.api_surface = private, internal
例
次の例は、空のインターフェイスを示しています。
// Violates rule
public interface IBadInterface
{
}
' Violates rule
Public Interface IBadInterface
End Interface
.NET