写项目应该遵循的代码规范

前言

	优美的代码，让人看起来非常舒服。丰富的文档，让人维护起来非常方便
	早日养成开发代码的规范是非常重要的，而不是等着项目越来越大，代码越来越乱，才开始后悔：哦~~，早知道
这样，我就应该一开始就变量命名规范点；文档齐全点；日志更加准确点；应该把经常变动的配置放到配置文件而不是
代码中；文档应该及时随着代码更改而修改而不是一拖再拖；不使用任何魔法值（未声明直接生成的变量，不利于维护
与他人阅读）。不统一的字符编码造成意料之外的错误等等。。。。

下面简单总结一下最常用到的规范，完整的可以参考：阿里巴巴的java开发手册

1：源文件一律使用UTF-8编码。
2：除了行结束符之外，空格是唯一能够使用的空白字符，不允许使用Tab字符（制表符）进行缩进。
3：除了是静态导入（import static 语句）之外，在导入包时，不能有通配符，应当指明完整的类路径
4：属性，方法，内部类不要交叉定义。   属性与属性定义在一起，方法与方法定义在一起
5：每行的代码长度必须限制在120个字符之内，如果一条语句超出了120个字符，包含任何缩进的字符，应该换行，包括注释在内。
			每行最多120个字符，是为了能够尽量在一个屏幕中，显示所有代码，而不需要拖动横向滚动条
6：每次变量声明时只能声明一个变量，不允许有类似于下面的情况：int a, b，必须要分开声明
7：为了最小化本地变量的作用范围，本地变量应该在他们第一次需要使用的时候声明。
8：在方法，类，属性上添加注解时，注解必须在上一行，不允许和属性，类以及方法的声明在同一行
9：类，属性，方法上的注解必须是独立的行，参数注解在参数前面即可。
10：标识符必须要使用ASCII字母以及数字，以下情况可以使用下划线：
		实现了某个数学算法的方法，为了保持命名和公知的算法命名一致，该方法中的一些本地变量可以使用下划线
		测试方法的命名
		常量名
11：所有的包名必须小写，不允许有下划线
12：类名使用UpperCamelCase风格，必须遵守驼峰形式，但是与领域模型相关的命名可以有例外，比如DAO, VO,DTO等
13：类名应该是典型的名词或者是名词短语。接口名可以是典型的名词或者是名词短语，也可以是形容词或者是形容词短语，比如Comparable.

			对于异常类，必须以Exception结尾
			
			对于抽象类，必须使用Abstract或者是Base开头
			
			对于测试类，必须是以被测试类的类名开头，并加上Test。
			
			对于实现类，可以使用接口类名加上Impl来表示对应接口的实现类。比如DAO和Service的实现类。
14：方法名使用lowerCamelCase风格，必须遵守驼峰形式

			方法名必须是典型的动词或者是动词短语
			
			测试方法应该是以test开头，然后是被测试的方法名称，最后如果测试的是某种状态或者是异常，可
			以再最后添加上_state或是_SomeException。比如testPush_emptyStack，testPush_nullException

15：常量名所有的字母都必须大写，并且使用_分隔开不同的单词。
16：非常量属性名使用lowerCamelCase风格，必须遵守驼峰形式。命名应该是名词或者是名词短语
17：参数名使用lowerCamelCase风格，必须遵守驼峰形式
18：每个类必须有注释说明类的用途
19：对于定义的接口，所有的方法必须要有注释，简要说明，方法的用途，当实现这些方法时，可以根据实际情况添加注释
20：注释使用中文，特别是在你的英语不太好的情况下，用中文描述清楚用途，远胜于用蹩脚英文
21：文档要及时跟着代码功能的更改而更改，千万不要一拖再拖