作为一个程序员,当然希望自己的代码读起来清晰明朗,于是最近闲暇时间看了看代码整洁之道,感觉收获颇多。一下总结一下书中关于命名规则方面的问题。。
写程序当然离不开变量名,类名,各种名。。。。如果没有个规范,不仅自己难以维护代码,更是让别人摸不到头脑。所以命名时候应该注意下一下的规则:
1名副其实
所谓名副其实就是写有意义的命名,让自己和别人读起来都能感觉到轻松愉快。。。当然不是像int days 一样 ,虽然知道其意义,但是表达不够明确
相比起来,int daysSinceCreation ,int daysSinceModification ,这样的命名就会让眼前一亮。。
2避免误导
作为程序员,我们可能接触很多方面的技术,而有时我们很可能就会弄混。(比如hp, aix ,sco )他们就不该做为变量名,他们是unix下的专有名称
我们也应该避免使用敏感的词汇,比如accountList 最好别用来制定一组账号 ,除非他真的是list类型 (毕竟List对程序员来说有着特殊的意义)
宁可使用accountGroup 当然也要避免留下掩藏代码本意的线索(比如没有及时更新的注释)
3.做有意义的区分
比如现有一个Product类,但是如果还有一个ProductInfo 和ProductData类的话就会让读者难以区分 ,他们就像a,an the 一样有意义的废话。
废话就是冗余,而程序开发中最该避免的就是冗余。。。。当然还有想variable一样的词永远不要出现在命名中 ,table不要单独出现在表格中
而nameString也不会比,毕竟name总不能是浮点型吧。。。。。
4.用读的出来的名称命名
不用解释,能都得出来的命名都不会很次
5.命名最好能被很容易的搜索到
比如MAX_CLASS_PER_STUDENT随意查找一个单词都能查到该变量
6.避免使用编码
现在编码已经太多太杂了,我们没有必要在为自己添加负担
7.类名和对象名都因该是名词或者名词短语
比如 customer WikiPage Account Data Info 这样
8.每一个概念对应一个词
我们都应该有自己习惯的命名规则,但最好养成习惯,把每个抽象出来的概念选一个词,并且一以贯之
如果有COntroller 就最好别使用Manager Driver 这些单词。。。。。