引言
最近小组内一个比较初级的开发同学,在设计一个相对复杂的任务时,咨询我关于接口、结构和方法\函数怎么命名才能显得比较高级。
我理解他的意思是,怎么命名才能更加表达意图,便于阅读理解。
如何命名
以下是根据个人经验,总结的命名规则:
1、接口(Interfaces)要使用主动名词
接口通常被设计为一种描述行为或者能力,而不是一种对象或状态。通过使用主动名词,可以更清洗地表达接口的用途和功能,使代码更具可读性和表达性。如Reader、Writer、JobProcessor、Formatter、Notifier。
2、结构(Structs)使用普通名词
结构通常用于表达一组相关的数据,使用普通名词更能清晰地表达这些数据的本质。如,使用Persion表示一个人的信息,使用Car表示一辆车的信息。
3、函数(Functions)使用动词
函数用来执行操作,因此通常使用动词进行命名。例如,calculateTotal、validateInput。可以清晰地表达函数的操作,以使代码的意图更加明确。 同时,尽量避免使用过于简略的函数名,以确保函数名足够描述函数的功能。举例来说,如果有一个函数用于保存数据,可能会被命名为saveData,而不是简单的save。