关键点
“别人还能把这个名字理解成什么意思?”通过不断的问自己这个问题来积极检查每一个命名。
事实上,这种富有创造性的、不断尝试“错误理解”的方法,能够有效的发现歧义的命名,并修正它们。正如本文中的示例,我们将随时通过“骑驴看唱本 ——边走边瞧”的方式来 探讨所见到名字的误解之处,然后选取一个更好的名字。
示例:Filter()
假设写了一段代码来操作数据库结果的集合:
results= Database.all_objects.filter("year <= 2011")
那么,results包含什么数据呢?
所有满足year<=2011的对象
所有不满足year<=2011的对象
问题的由来是从filter这个有歧义的词开始的,它没有清楚表达它的意思是“选取”还是“剔除”。因此,应该避免使用filter,它太容易造 成误解!
如果这里想要的效果是“选取”,一个更好的名字是select;如果想要的是“剔除”,更好的名字则是exclude。
为布尔值取名
当为布尔值变量命名或者函数返回布尔值的时候,要特别注意真和假所表达出来的真实意思,这里就有一个很危险的例子:
bool read_password= true;
这句代码意思取决于当时怎么阅读的(没有其他的意思了),显然这里有两种截然不同的理解:
需要读密码
密码已经被读过了
在这个用例下,做好避免用单词read,可以考虑使用need_password或者user_is_authenticated来代替。
通常情况下,添加单词is、has、can或者should可以让布尔值的意思更加清晰易懂。
比如说有个函数叫SpaceLeft(),乍一看,就会想到这个函数返回的值是数字。如果需要明确返回值是布尔值,一个更好的名字是 HasSpaceLeft()。
还有,尽量避免使用反义短句来命名。例如:
bool disable_ssl= false; |