CA1713:事件不應該有 before 或 after 前置字元

  • 發行項
屬性 值
規則識別碼 CA1713
標題 事件不應該有 before 或 after 前置字元
類別 命名
修正程式是中斷或非中斷 中斷
預設在 .NET 8 中啟用 No

原因

事件的名稱以 『Before』 或 'After' 開頭。

檔案描述

事件名稱應該描述引發事件的動作。 若要命名在特定序列 (Sequence) 中引發的相關事件，請使用現在式或過去式表示動作序列相對的位置。 例如，在關閉資源時命名引發的事件組時，您可以將它命名為 'Closing' 和 'Closed'，而不是 'BeforeClose' 和 'AfterClose'。

命名慣例是以通用語言執行平台為目標的程式庫，提供一種通用的寫法。 如此一來，可縮短新軟體程式庫所需的學習曲線，並且因為程式庫是由具備開發受控程式碼專業知識的人員所開發，進而提升客戶的信賴感。

如何修正違規

從事件名稱中移除前置詞，並考慮變更名稱以使用動詞的目前或過去時態。

隱藏警告的時機

請勿隱藏此規則的警告。