Java新手进阶(大头菜联盟)--书写规范

    作为刚刚步入职场的新人，第一次的任务一定要给同事留下好的印象。大家都能容忍一个新人的代码质量差，工作效率不高，但是无法容忍代码书写的乱七八糟没有格式。在你一穷二白没有任何资历的情况下，一份书写工整的代码文件，会成为你和同事之间社交的保障。

    详细的Java书写规范有很多，网上搜索会出很结果，也包括BAT大厂自己整理的规范。但是那些对于新人来讲过于严格，并且很多也看不懂，可能一辈子也用不到。我这里讲的是最基础的，不涉及到逻辑，执行效率，炫技等问题的。规定一旦多了一时也记不住，不如记住一些最实用的。看似很简单的规则，但是每个新人都会犯这种错误，不要不以为然。

1.命名规则

    类名，函数名，变量名，起名一定要有规则有依据，不能随便写。能使用英语的尽量使用英语。遵循驼峰命名法，简单来说就是每个英文单词的首字母大写，看起来像驼峰一样，一高一低。

类名，第一个字母要大写：

StudentService：学生服务类

GoodsController：商品信息控制器类

TeacherEntity：教师实体类

函数名，尽量是动词开头

getAge()：取得年龄。

queryById()：通过Id查找。

变量名，尽量使名词

carCount：车数

userName：用户名

tagNam：标签名称

禁止使用a,b,c,t1,t2,这样的没有意义的变量名称。

2.缩进

    写代码和语文写作文一样，是要有段落层次。曾经一个同学，代码写了几十行，通篇没有一个空行，还自作聪明，把所有行的开头全都对齐，还得意洋洋的，竟不知道自己有多的无知愚蠢。

错误的例子：

正确的是这样：

3.括号

小括号，大括号和他相邻的关键字之间一定要有空格隔开。

错误的例子:

正确的例子：

对于if-else的括号写法，有几种风格，我们尽量要和大部分人的风格一致。

第一种：行内括号

第二种：行间括号

可以看到第二种，代码量会多一些。据说在一些外包公司，按代码量算钱的时候是很有用的。

运算符前后有空格

定义变量

错误的例子:

正确的例子：

比较条件

错误的例子:

正确的例子：

4.空行

行间段落，完成一段逻辑，空一行。使得代码有段落。

5.注释

注释是必要的，尤其在你写的代码很混乱的时候，重要的地方写一些注释，可以很好的让其他的成员理解你的意思。有些变量的名字，英语难以表达，适当的再补充一些注释。

有的同学一听写注释，错误的认为每一行都要写，导致写了50行代码，又多出来50行注释，真是画蛇添足。写注释要适当。

6.函数化

尽量一个函数控制在200行以内。涉及到通用化的逻辑，可以抽取出来，形成一个函数，供大家调用。最后的代码就是函数之间的相互调用，每个函数实现自己的功能。曾经有一个历史很久远的程序，只有一个函数，这个函数有10000行左右。因为几十年经历了很多个人进行维护，每个人都是在原来的基础上加功能，没有统一规划，最后的结果就是导致越来越大。大家想想这样的风格好吗。