函数命名的艺术

Aki 发布于 2022-11-11 191 次阅读


驼峰命名法(CamelCase)

驼峰命名法应该我们最常见的一个,这种命名方式使用大小写混合的格式来区别各个单词,并且单词之间不使用空格隔开或者连接字符连接的命名方式

类名需要使用大驼峰命名法(UpperCamelCase)

正例:

ServiceDiscovery、ServiceInstance、LruCacheFactory

小驼峰命名法(lowerCamelCase)

方法名、参数名、成员变量、局部变量需要使用小驼峰命名法(lowerCamelCase)。

正例:

getUserInfo()、createCustomThreadPool()、setNameFormat(String nameFormat)
Uservice userService;

返回bool值函数的命名方法:

注:Prefix-前缀,Suffix-后缀,Alone-单独使用

规则一般是前缀加名词。

位置单词意义
Prefixis对象是否符合期待的状态isValid,isDigit
Prefixcan对象能否执行所期待的动作canRemove,canDelete
Prefixshould调用方执行某个命令或方法是好还是不好,应不应该,或者说推荐还是不推荐shouldMigrate
Prefixhas,include,contain对象是否持有所期待的数据和属性hasObservers,containWifi,
Prefixneeds调用方是否需要执行某个命令或方法needsMigrate

获取数据类型函数的命名方法:

规则一般是动词加名词。

位置单词意义
Prefixget直接从对象,数据结构中获取某些数据getUserInfo(),getId(),getName()
Prefixfetch通过网络获取到某些数据fetchUserInfo()
Prefixload通过配置文件中获取到某些数据loadUserInfo(),
Prefixcalculate,简写为cal通过计算获取到某些数据calAverageScore(),calUserId()
Prefixfind,query通过查找数据库等等获取到某些数据findUserInfo()