CA1030:適切な場所にイベントを使用します

[アーティクル]
09/06/2023

プロパティ	値
ルール ID	CA1030
Title	適切な場所にイベントを使用します
[カテゴリ]	デザイン
修正が中断ありか中断なしか	なし
.NET 8 では既定で有効	いいえ

原因

メソッド名は次のいずれかから始めます。

AddOn
RemoveOn
Fire
Raise

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

規則の説明

この規則では、通常はイベントに使用される名前を持つメソッドを検出します。イベントは、オブザーバーまたは発行-サブスクライブのデザインパターンに従います。あるオブジェクトの状態変化を他のオブジェクトに伝える必要があるときに使用されます。明示的に定義された状態変化に応答してメソッドが呼び出される場合、メソッドはイベントハンドラーから呼び出す必要があります。メソッドを呼び出すオブジェクトは、メソッドを直接呼び出すのではなく、イベントを発生させる必要があります。

イベントの一般的な例の一部は、ボタンクリックなどのユーザーアクションでコードセグメントが実行される、ユーザーインターフェイスアプリケーションで見つかります。 .NET イベントモデルは、ユーザーインターフェイスに限定されていません。状態変化を 1 つまたは複数のオブジェクトに伝えなければならないあらゆる場所で使用してください。

違反の修正方法

オブジェクトの状態が変化したときにメソッドが呼び出される場合、.NET イベントモデルを使用するようにデザインを変更することを検討してください。

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

メソッドが .NET イベントモデルで動作しない場合、この規則からの警告は非表示にします。

警告を抑制する

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

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

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

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

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

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

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

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

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

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

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

dotnet_code_quality.CAXXXX.api_surface = private, internal

次の方法で共有