CA1713:事件不应具有 before 或 after 前缀
属性 | 值 |
---|---|
规则 ID | CA1713 |
标题 | 事件不应具有 before 或 after 前缀 |
类别 | 命名 |
修复是中断修复还是非中断修复 | 重大 |
在 .NET 8 中默认启用 | 否 |
原因
事件的名称以“Before”或“After”开头。
规则说明
事件名称应描述引发该事件的操作。 若要命名按特定顺序引发的相关事件,请使用现在时或过去时指示一系列操作中的相对位置。 例如,在对关闭资源时引发的一对事件进行命名时,可将其命名为“Closing”和“Closed”,而不是“BeforeClose”和“AfterClose”。
命名约定为面向公共语言运行时的库提供通用外观。 这缩短了新软件库的学习曲线,让客户更加相信该库是由拥有托管代码开发专业知识的人员开发的。
如何解决冲突
从事件名称中删除前缀,并考虑更改该名称,使用谓词的现在时或过去时。
何时禁止显示警告
不禁止显示此规则发出的警告。
反馈
https://aka.ms/ContentUserFeedback。
即将发布:在整个 2024 年,我们将逐步淘汰作为内容反馈机制的“GitHub 问题”,并将其取代为新的反馈系统。 有关详细信息,请参阅:提交和查看相关反馈