CA1070：請勿將事件欄位宣告為 virtual

文章
12/16/2023

屬性	值
規則識別碼	CA1070
標題	請勿將事件欄位宣告為 virtual
類別	設計
修正程式是中斷或非中斷	中斷
預設在 .NET 8 中啟用	建議

原因

field-like event 已宣告為虛擬。

根據預設，此規則只會查看外部可見的類型，但這是可設定的。

檔案描述

請遵循這些 .NET 設計指導方針，在衍生類別中引發基類事件。請勿在基類中宣告虛擬事件。覆寫衍生類別中的事件具有未定義的行為。 C# 編譯器無法正確處理此程式，而且無法預測衍生事件的訂閱者是否會實際訂閱基類事件。

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

如何修正違規

請遵循這些 .NET 設計指導方針，並避免類似虛擬欄位的事件。

隱藏警告的時機

如果事件是已隨附程式庫一部分的外部可見公用 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 介面

您可以根據程式碼基底的存取範圍，設定要執行此規則的部分。例如，若要指定規則只應該針對非公用 API 介面執行，請將下列機碼/值組新增至 專案中的 .editorconfig 檔案：

dotnet_code_quality.CAXXXX.api_surface = private, internal

另請參閱

設計規則

分享方式：