文档介绍：编码规范编写目的本规范的目的在于编写可靠的、一致的、便于理解的JAVA源代码,并且写出的代码被其他人阅读,所有的JAVA代码保持良好的致性,容易在以后的阶段中进行维护和升级。同时,也是为了通过一定时间的实践,增加我们的软件产品的投入产出量,以提高我们的工作效率。适应范围适用于JAVA程序开发人员,或后续开发人员。可以方便系统的开发与维护,使系统开发与维护可以顺利展开。代码命名一般原则我们开发的是一个JSP新闻发布系统,用的编码方式是JAVA,因此用的命名总原则是:.用全英文单词命名的方式,准确地描述变量、属性、类等。如:使用firstNname、grandTotal、等命名就比x1、y1、fn等更容易让人理解其含义,尽管它们的长度要大一些。。例如:如果我们的用户称他们的clients为customers,那么我们就应该用customer来命名,而不是采用client来命名。这是一些细微的地方,但也希望能注意。,以便命名有很好的可读性。在JAVA代码中,将采用如下原则:类或接口命名中每个单词的首字母均大写,而单词的剩余部分均小写。其它像变量、成员方法、属性等除第一个单词全部小写以外,其它单词的首写字母均大写,而单词的剩余部分均小写。,但如果一定要用,则选择大家通用的缩写方式,并且要在本JAVA源代码中坚持用它,而不要一会用这种缩写方式,一会用那种缩写方式。比如,如果要用“number”的缩写方式,则可用“no”或“num”两种缩写方式,而不要用“nu”这种大家不常用的缩写方式,并且要保持不变。,一般以少于20个字符为宜。:两个或多个命名仅仅是其中的有些字符大小写不一样,或者仅仅是其中有些单词是单复数之区别。例如:persistentObject与persistentObjexts;anSqlDatabase与anSQLDataBase等。。在JAVA中,一般比较少的采用下划线的命名方式。,为了使以后的代码具有可读性与可维护性,为了使代码可重复使用,因此对代码进行注释是很有必要的,做好代码注释规范是有意义的,我们应做好以下几点:代码注释应简洁明了,使开发人员与维护人员能一目了然。避免使用多余重复的代码注释。代码注释应使用简单易懂的代码注释语言。如有特殊的代码要加以说明,表明为什么要这样做。代码注释时应该写在相应的位置处。代码注释应写的规范整齐。在编写代码时就注释,因为以后很可能没有时间这样做。另外,如果有机会复查已编写的代码,在今天看来很明显的东西六周以后或许就不明显了。修改代码时,总是使代码周围的注释保持最新。注释应该是解释为什么存在和可以做什么。在编写注释时使用完整的句子。注释应该阐明代码,而不应该增加多义性。避免多余的或不适当的注释,如幽默的不主要的备注。避免杂乱的注释,如一整行星号。而是应该使用空白将注释同代码分开。避免在块注释的周围加上印刷框。这样看起来可能很漂亮,,命名格式:Package包名(例如:Packageentity)