次の方法で共有

CA1070: イベント フィールドを virtual として宣言しません

  • [アーティクル]
プロパティ 値
ルール ID CA1070
Title イベント フィールドを virtual として宣言しません
[カテゴリ] デザイン
修正が中断ありか中断なしか あり
.NET 8 では既定で有効 提案として

原因

フィールドのように使用するイベントが virtual として宣言されました。

既定では、この規則の対象は外部から参照可能な型のみですが、これは構成可能です。

規則の説明

派生クラスで基底クラスのイベントを発生させるには、次の .NET デザインガイドラインに従います。 基底クラスで virtual イベントを宣言しないでください。 派生クラスのオーバーライドされたイベントには定義されていない動作があります。 C# コンパイラではこれが正しく処理されません。派生イベントのサブスクライバーが基底クラス イベントを実際にサブスクライブするかどうかは予測できません。

using System;
public class C
{
    // CA1070: Event 'ThresholdReached' should not be declared virtual.
    public virtual event EventHandler ThresholdReached;
}

違反の修正方法

.NET デザイン ガイドラインに従い、virtual フィールドの類いのイベントを回避します。

どのようなときに警告を抑制するか

イベントが、既に出荷済みライブラリの、外部から参照可能なパブリック API である場合、ライブラリ使用者に対する破壊的変更を回避するために、この規則の警告を表示しないようにしても問題ありません。

警告を抑制する

単一の違反を抑制するだけの場合は、ソース ファイルにプリプロセッサ ディレクティブを追加して無効にしてから、規則をもう一度有効にします。

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

ファイル、フォルダー、またはプロジェクトの規則を無効にするには、構成ファイルでその重要度を none に設定します。

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

詳細については、「コード分析の警告を抑制する方法」を参照してください。

分析するコードを構成する

次のオプションを使用して、コードベースのどの部分に対してこの規則を実行するか構成します。

このオプションを構成できる対象は、この規則だけ、それを適用するすべての規則、それを適用するこのカテゴリ (デザイン) のすべての規則のいずれかです。 詳細については、「コード品質規則の構成オプション」を参照してください。

特定の API サーフェイスを含める

ユーザー補助に基づいて、この規則を実行するコードベースの部分を構成できます。 たとえば、非パブリック API サーフェイスでのみ規則を実行するように指定するには、プロジェクトの .editorconfig ファイルに次のキーと値のペアを追加します。

dotnet_code_quality.CAXXXX.api_surface = private, internal

関連項目