代码编写规范

起名篇

通用原则

[1] 函数与变量名称要能够表达出其正确的含义，不要使用魔数（直接量）

[2] 类名和对象都应该时名词或者名词短语，类名不应该是动词，毕竟类是对事物的抽象而不是行为的抽象（方法才是对行为的抽象）

变量命名原则

[1] 不轻易使用类型名称作为变量的后缀，例如使用List作为后缀时，该变量应该真的是一个List类型的，而不是为了表示该变量是一个集合，想要表示出集合概念可以使用Group或者Batch之类的词；

[2] 避免使用相似度较高的名称，这会直接影响阅读和敲代码的体验，当出现多个概念相似的对象时可以通过定义不同的前缀来快速区分；

[3] 做有意义的区分，当多个变量属于相同类型的数据时，不要直接通过简单的标识符来区分（如1, 2, 3; a, b, c），思考下定义这个变量的目的是什么，自然可以写出更有意义和目的明确的变量名；

[4] 名称中不要加废话，例如ageInt，nameString中的Int和String是完全没有必要的；

[5] 名称要能读的出来，可以读出来的名称才能方便交流，也能做到望词生义；

[6] 使用能够直接搜索到的名称，用变量代替魔数可以让我们更快的定位该值都在哪些地方使用过；

[7] 添加有意义的语境，如果直接使用name或者address之类的词作为变量名称，我们很难准确地知道它要表达的是什么意思，必需在了解了上下文之后才能知道它表示的是一个人的名称和住址还是建筑的名称和住址，这时就应该在name、address前加上前缀进行区分，studentName或者schoolName。再或者直接定义出Student类，通过对象访问student.name也可以实现清晰的表达；

[8] 不要添加没用的语境，与上一条相反，如果我们已经定义了Student类，那么类中的变量名称就没必要定义成studentName或者studentAddress，通过类就已经能够准确区分变量所属的领域概念；

方法命名原则

方法是对行为的抽象，所以方法的命名应该是动词或者动词短语

[1] 对象属性的访问和修改都应该使用动词+属性值命名；

[2] 短小不是方法命名的原则，清晰的表达方法的作用才是，方法命名时不要担心方法名称太长；

参考

[1] 《代码整洁之道》