一些开源代码的事件命名很混乱,以此博客用作本人以后工作的参考。
事件的名称
事件始终是指某个操作,这个操作可能正在发生,也可能已经发生。 因此与方法一样,事件用谓词命名,谓词时态用于指示事件引发的时间。
✓ 务必使用谓词或谓词短语来命名事件。
示例:Clicked
、Painting
、DroppedDown
等。
✓ 务必通过使用现在时态和过去时态,让事件名称含有时间先后的概念。
例如,窗口关闭之前引发的事件称为 Closing
,窗口关闭之后引发的事件称为 Closed
。
X 请勿使用 “Before” 或 “After” 前缀和后缀来指示事件之前或之后。 应按前述使用现在时态和过去时态。
✓ 请使用 “EventHandler” 后缀来命名事件处理程序(用作事件类型的委托),如以下示例所示:
public delegate void ClickedEventHandler(object sender, ClickedEventArgs e);
✓ 务必在事件处理程序中使用两个名为 sender
和 e
的参数。
sender 参数表示引发事件的对象。 sender 参数的类型通常是 object
,且可能会使用更具体的类型。
✓ 务必使用“EventArgs”后缀来命名事件参数类。
个人建议:对于名称意义不明的事件可添加Event后缀,尽量少用后缀。
事件触发方法的名称
事件需要有一个事件触发方法,用于检测事件是否有绑定的方法,如果有就触发事件。直接触发事件在事件没有绑定方法时会引发空异常。
✓ 务必使用“On+事件名称”来命名事件触发方法。