代码整洁之道(一):命名篇

代码质量与其整洁度成正比。干净的代码,既在质量上较为可靠,也为后期维护、升级奠定了良好的基础。

有意义的命名

  1. 名副其实 变量命名,要能够见名知义;函数命名应能够体现出整个函数的意义。 长名称一般好于短名称。长名称一般更能够凸显该变量的含义。也更便于搜索,便于理解。除非是诸如sum、temp等具有明显临时功能的变量都有赋予其明显含义。

  2. 避免误导 避免使用带有某些特殊意义的特别是在计算机领域具有某些意义的词语:诸如hp、ubuntu、dos、table等。同时避免在代码中出现具有相同或者相近的变量命名:例如同一个单词大小写不同或者加入了下划线等都会带来误解。当然,并不是说两个函数的局部变量不能取相同或者相近的名字。尽可能避免误解即可。

  3. 做有意义的区分 例如: getActivateAccount();getActivateAccounts();getActivateAccountInfo();这就是毫无意义的函数命名,因为程序员无法知道怎么去调用。

  4. 使用读得出来的名称 不要随意造词,也不要随意进行缩写。除非是某些专有缩写可以直接在词典中查到,否则不能使用。 统一使用英文,不要使用汉语拼音替代。

  5. 避免思维映射 对于某些程序段常用的变量名应遵从规范。例如i、j、k等常用语for循环中。然而在多数情况下,不要使用单字母命名。另外特别注意不要使用o或者l等很难与0和1进行区分的字母。

  6. 类名 类名和对象名应该是名词或者名词短语,不应当是动词。

  7. 方法名 方法名和函数名应当是动词或者动词短语。

  8. 避免双关语 遵循一词一义的原则。

  9. 添加有意义的语境

posted @ 2019-08-29 20:23  LightningStar  阅读(462)  评论(0编辑  收藏  举报