摘自:代码那些事之命名——《可读代码的艺术》读后感
http://bj007.blog.51cto.com/1701577/1309002
选择具体的词
比如GetPage函数命名中Get就比较空泛,可能有几种情况,比如从文件读取、去远处获取、去数据库查询、或者就是简单地从返回成员变量,如果一切都是Get就需要扒开具体实现才可能确定到底用哪种方式。如果我们可以选择更具体的词,比如文件读取用Read或者Load、远程获取用Fetch、数据库查询用Query、简单返回成员变量时候采用Get,并且整个项目保持一致,可能仅仅看到名字就可以闪现出对应的场景。将信息塞进名字中的一部分就是选择很具体、避免空泛的一些词。
避免误解。
被误解是很受伤的一件事,但是我们的命名就尝尝别误解,而且还常常是整个意思反过来了。因此在检查名字的时候就是主动问下自己“别人对于这个名字是否有不同的解读?”。比如如下代码:
results = Database.all_objects.filter("year <= 2011") |
其中,results会包含什么呢?问题就出在filter上,可能是过滤掉、也可能是过滤出。建议就是如果要过滤出,select()会更好,如果要过滤掉,exclude()会更好。