JAVA-编码规范-代码风格-命名

引言：

很多java规范，内容偏向于对排版的要求，对java语言特性使用上的注意事项描述较少，为了能帮助我们合理的使用java语言，规避语言陷阱，特发此专题博客。

代码总体原则：
1:清晰第一。清晰性是易于维护,易于重构的程序必须具备的特征；
2:简洁唯美。简洁就是易于理解并且易于实现；
3：选择合适的风格，团队保持一致；
除此之外，java编程还应注意一下几个方面；
1：正确使用java
    面向对象技术使得程序结构清晰，简单，提高了代码的重用性，但又隐藏了很多内部实现细节；很容易陷入陷阱。使用许多java特性时，要注意正确使用。比如：多线程并发，泛型，装箱数据类型，异常处理，对象克隆等；
2：安全高效。

核心内容：JAVA-编码规范-代码风格-命名

代码风格：

原则一   为包，类，方法，变量 取一个好名字，使代码易于理解
好的命名，特征如下：
(1)能清晰的表达意图：使用完整的描述性单词，避免使用单个字母，未形成惯例的缩写来命名。例如：int elapsedTimeInDays要比int d好得多；
(2)避免造成误导：有误导的名字比表达不清的名字更有危害性，比如String accountList其实并不是一个List，a=1;是数字1还是字母l;TTLCONFUSION于TTLC0NFUSION名称太相似；
(3)避免不必要的编解码：代码被人阅读的次数会很多，因此要注意可读性，避免不必要的人脑编解码，比如在JAVA中不建议采用匈牙利命名法，Java是强类型的语言，且IDE已经很先进，在编译时就能发现类型错误，因此匈牙利命名法无用武之地，况且它可能导致错误信息，比如PhoneNumber strPhone当类型变更后，名称未变更导致提供错误信息；
(4)能区分出意思：比如以下名称，product,productInfo,productDate表达的意思差不多，让人从名称并不能区分出它们各自代表的东西有什么不同，因此建议不要在变量/类名后加info,data,object等一般意义的词；
(5)不用或少用缩写：小于15个字母的一般不用缩写。超过15个字母的，可以采用去掉原因字母的方法或者行业内约定俗成的缩写，且缩写保持驼峰格式，不要编造不符合习惯的缩写。比如serviceDataPoint,可以缩写为svcDataPnt,不可缩写成SDP.如果要用缩写，仅第一个字母大写其余小写，例如:getHTTPRequest改为getHttpRequest;
规则1：禁止使用魔鬼数字
说明：直接使用数字造成代码难以理解，也难以维护。应采用有意义的静态变量或枚举来代替。
例外情况：有些情况下，如循环或比较时采用数字0，-1,1,这些情况可采用数字；

示例

	不好：int doorState = 5;
	推荐：static final int CLOSE = 3; int doorState = CLOSE;
		enum Signal
		{
			GREEN,YELLOW,RED
		}
		public class TrafficLight
		{
			Singal color = Signal.RED;
			public void change()
			{
				switch(color)
				{
					case RED:
						color = Signal.GREEN;
						break;
					case YELLOW:
						color = Signal.RED;
						break;
					case GREEN:
						color = Signal.YELLOW;
						break;
					default:
						color = Signal.RED;
				}
			}
		}

	 示例：不好：
		public String type();
		public boolean Finished();
		public void visible(boolean);
		public void DRAW()
		public void KeyListener(Listener);
		推荐：
		public String getType();
		public boolean isFinished();
		public void setVisible(boolean);
		public void draw();
		public void addKeyListener(Listener);