代码规范 : 自解释的神话

写在前面: 好想找个女朋友,这样就可以帮我想变量名了,(玩笑脸)

多数初学者觉得,特意为代码去取一个名字没有必要.可你该明白: “代码阅读次数远远多于编写的次数, 确保名字更侧重于阅读方便而不是编写方便”
(当然,如果你认为你的程序能够满足”很好的描述了现实生活中的场景”,那么恭喜,你可以不用看着一篇文章了)

---

基本命名规范

计算机科学家想做的,就是将代码抽象成现实中有的事物,而命名就围绕这个想法展开.

一个好的名字不外乎: 简短, 能描述所代表的含义

• 接口(双驼峰):
  1 对于Service 和 DAO 类 (下面有列表给出),实现类的后缀是 impl
  2 形容能力的接口 以 able 作为后缀

• 类名(双驼峰),应该是对一个类别的描述,常常会使用名词

• 函数(单驼峰),应该是动词,或者是动词短组(动词 + 宾语),并且描述其返回值
  例如:

• 参数,成员变量(单驼峰): 在多个相同的类型的参数,绝对不允许出现 name1 2name 这样的对象名,最多有人是用来表示 For 4 To 2 这样的

• 常量(全部大写):

    下划线隔开 MAX_STOCK_COUNT

    不允许出现魔法值(单独未定义的值)
    例如: 
        String personInfo = name + " and " + age
    这样是不被允许的

    不允许出现硬编码(和上面一条类似)

    // 用硬编码绑定到变量上可读性差
    titleBar.color = 0xFF;

    // 方法一:用常量代替硬编码( 编译时绑定其值的变量)