坚持一件事确实不容易,从3月11日发第一篇阅读笔记,当时想着每天都读半小时,把自己理解和认为有有的写下来,主要是对自己的总结鞭策,如果能为他人带来些作用,那更好。
今天阅读《核对表:变量命名》,是个很好的内容,就像代码走查25疑问一样,通过核对表,我们可以检查核实自己所取的变量合是不是个好变量名。
命名的一般注意事项:
- 名字完整并准确地表达了变量所代表的含义吗?
- 名字反映了现实世界的问题而不是编译语言方案吗?
- 名字足够长,可以让你无须苦苦思索它的意义蚂?
- 如果有计算值限定符,它被放在名字的最后吗?
- 名字中用Count或者Index来代替Num了吗?
如果以上问题你都回答了是,或者大部份回答了是,那么恭喜你。
命名规则
- 规则能够区分局部数据、类的数据和全局数据吗?
- 规则能够区分类型名、具名常量、枚举数据和变量名吗?
- 名字为了可读性而加以格式化了吗?
短名字
- 代码用了长名字吗(除非有必要使用短名字)?
- 是否避免只为了省一个安符而缩写名字的情况?
- 所有单词的缩写方式都一致吗?
- 名字能够读出来吗?
- 避免使用容易被看错或者读错的名字吗?
- 在缩写对照表里对短名字估出说明吗?
为特定类型的数据命名
- 循环下标的名字有意义吗(如果循环长度超过5行或者出现嵌套循环,那么就应该使用i、j、k之外的其它名字)?
- 所有的”临时“变量都重新命名以更有意义的名字了吗?
- 当布尔变量的值为真时,变量名能准确表达其含义吗?
- 具名常量是根据它所代表的抽象实体而不是它所代表的数字来命名的吗?
要点
- 代码阅读的次数无无多于编写的次数。 所以编码时不要赚麻烦,图一时之快,不细致考虑命名。要确保你所取的名字更侧生于阅读方便,而不是编写方便。
- 好的变量名是提高程序可读性的一项关键要素。
- 名字要尽可能地具体。
到此,关于变量命名的内容就结束了, 通过这段时间的阅读,确实也对工作产生了帮助,在命名上进行了调整,提高了代码可读性,变量名、方法名取得好,注释都可以少写很多。这个系列已经发了五篇,对bolg发文、排版,也熟悉了些,收获还是不小。
由于是阅读笔记,大多内容只是摘抄或进行了精减,如需看完整内容,请看原书。