做程序员要积德 Java代码规范之我见

　　最近一个多月的时间一直在公司里呆着，因为是刚出项，所以部门经理就让我先休息下，待下个项目定后再进项。没想到我一呆就是一个多月，这种不干活的感觉还着实让我感到无所适从，部门经理看出来了，就让我帮他做下OA，完善和增加些功能。当我拿到公司OA代码后，环境搭建完毕后就开工咯，当我打开几个文件后，看到一行行凌乱的代码在眼前飞舞，逻辑条理一点儿都不清晰，顿时头大，神啊这让我从何下手，由此我才更加深刻地体味到写代码规范点是件多么积德的事儿。

　　我认为代码规范的第一要义是，要让读你代码的人一眼就能看出个脉络，而不是变量一大堆，if...else...像蜘蛛网似的层层嵌套，让接手你代码的人还得想半天才发出“哦，原来是这样”的感叹。我们试想下，如果真是有人发出了这样的感叹，紧接着他会说些什么呢，哈哈，他肯定会破口大骂“这人怎么写会这么垃圾的代码，尼玛地”。这种情境当然不是我们的初衷，更不是我们想要的评价。所以，我们一定要在写代码时站在别人的角度去写，规范起来，让每个接手的人都能轻而易举地看懂，改起来就能快速上手了。下面是我平时自己写代码时的会去考虑的几个要点，希望与大家共同交流探讨下：

　　1、注释( 注释的简洁，注释的位置，注释的数量)

　　注释内容要简单、明了、含义准确，防止注释的多义性，错误的注释不但无益反而有害。另外还要保证注释与其描述的代码相邻，即注释的就近原则。

　　可能会有人问，注释太多的话不就无形之中让我们的代码文件变得很大吗?其实注释在编译代码时会被忽略，不编译到最后的可执行文件中，所以注释不会增加可执行文件的大小。

　　我平时写的每一个方法都会在像下面这种形式：

　　/**

　　* 功能描述.....

　　* @param 参数描述...

　　* @return 返回描述....

　　*/

　　public void xxx(String xxx, ....){

　　......

　　}

　　2、命名(采用英文)

　　大部分语言只支持用字母编程，有些编程语言可以用中文做变量名哦!像PHP就能，但采用中文是种非常不科学的做法，因为涉及到字符集、跨平台等诸多问题，所以坚决杜绝使用。

　　那么采用拼音可以吗?我觉得也不可取，因为拼音的简写实在太飘逸，比如一个“SB”，你只会联想到“傻X”，而不会联想到“上班”、“顺便”、“随便”等，如果用“Shab”或者“Sbi”作为简写，那将会更匪夷所思，拼音基本上无法使用简写，所以我提倡用英文，因为英文在使用简写的时候，基本不会产生歧义，除非你让它有了产生歧义的可能。

　　3、if...esle....(尽量少用else，更要避免嵌套的情况出现)

　　if...else....是任何一门编程语言中必用到的逻辑控制语句，即分支结构。但我们在用它的时候要注意易读的原则，切不可层层嵌套(非不得已情况下)，深不可测。

　　小结，其实写代码还有很多的地方要注意，我只写出了我平时最关注的三方面的内容，希望与大家共勉，不当之处，恳请请点教导。我还有很多东西要学习，还有很长的一段路要走。好啦，时间不早了，该休息了，身体是革命的本钱，我们这些IT人士也要切记健康至上，不要熬夜。

　　文章来自：JAVA培训指南网 原文链接http://www.java800.com/showArticle.php?atlid=3419126b-4142-1833-fe31-a249759eb498/，转载请标明，谢谢!