如何给函数取个合适的名字
下面是一些命名函数的技巧。
明确函数要做什么
在给函数命名前,明确函数到底要做什么。这有利于给函数命名。
以动词开头
函数总是做些什么,所以当然要以动词开头。
尽量不要以 do 开头
do 并不能给我们提供任何函数的信息。相比之下,search, compute, handle 之类的动词暗示着函数大概做了什么。
返回布尔值的方法以 is 或 are 开头
用 is 还是 are 取决于判断主体是单个还是多个。如:isButtonEnabled
,areButtonsEnable
。
合理的使用 get 作为函数名字的开头
所有有返回值的函数,好像都可以用 get 作为函数名字的开头。但以 get 开头的函数应该表示取某属性,如
var user = {
firstName: '',
lastName: '',
getFirstName: function(){
return this.firstName;
},
getFullName: function(){
return this.firstName + this.lastName;
}
}
否则就不应该用 get 开头。比如,从服务器上获取用户列表,这个方法可以叫 fetchUserList
,而不是 getUserList
;获取某个范围内的所有质数,可以叫 caculatePrime
。
不要包含上下文信息
如有个 user 对象,有个获取 user 的 id 的函数,应该叫 getId
而不是 getUserId
。
不要包含函数参数的信息
如用一个 id 和 token 找用户的方法,应该叫 findUser(userId, token)
而不是 findUserByUserIdAndToken(userId, token)
。如果以 findUserByUserIdAndToken
来命名,那么如果以后函数要支持用其他方式查找用户怎么办,又或是不支持用 token 查找怎么办。