JAVA编码标准.doc

,一致的,便于理解的JAVA源代码,并且写出的代码容易被其他人阅读,所有的JAVA代码保持良好的一致性,容易在以后的阶段中进行维护和升级。同时,也是为了通过一定时间的实践,增加软件产品的投入产出量,以提高工作效率。,所有的代码命名的总原则是:芃用全英文单词命名的方式,准确地描述变量、属性、类等。如:使用firstName,grandTotal等命名就比x1,y1,fn等更容易让人理解其含义,尽管它们的长度要大一些。蕿采用一些更加准确的术语来命名。例如,如果我们的用户称他们的clients为customers,那么我们就应该采用customer来命名,而不是采用client来命名。这是一些细微的地方,但也希望能注意。衿采用大小写混合的方式来命名,以便命名有很好的可读性。在JAVA代码中,将采用如下原则:类或接口命名中每个单词的首字母均大写,而单词的剩余部分均小写。其它像变量、成员方法、属性等除第一个单词全部小写以外,其它单词的首字母均大写,而单词的剩余部分均小写。莇尽量少用单词的缩写形式,但如果一定要用,则必须要选择大家通用的缩写方式,并且要在本JAVA源代码中坚持用它,而不要一会用这种缩写方式,一会用那种缩写方式。比如,如果要用“number”的缩写方式,则可用“no”或“num”两种缩写方式,而不要用“nu”这种大家不常用的缩写方式,并且要保持不变。蒂尽量避免太长的命名,一般以少于20个字符为宜。芃尽量避免使用这样的命名:两个或多个命名仅仅是其中的有些字符大小写不一样,或者仅仅是其中有些单词是单复数之区别。例如:persistentObject与persistentObjects;anSqlDatabase与anSQLDatabase等。蕿尽量避免使用下划线。在JAVA中,一般比较少的采用下划线的命名方式。(注:在使用CORBA时,系统会自动的生成一些带有下划线的属性,类名,接口名等等,或者是IDL接口在定义时会带有下划线的属性,类名,接口名等,在此种情况下,该条件可以适当放宽),我们经常要使用代码注释的方式来帮助理解代码的含义。代码注释的一般原则主要有以下几个方面:莀代码中的注释应该以让人一目了然为目标。我们之所以要增加代码注释,其目的就是为了让编写代码的人、同一项目组的成员或以后的开发人员能很容易的理解其代码的意图。膆避免使用标语式的、实际毫无用处的代码注释。袃尽量采用简洁、易懂的注释代码,而不要长篇大论。肁有些特殊的代码中要加以适当的注释,以说明其为什么要这样做。例如,一些特殊的商业规范的计算等等。螆芇在JAVA代码中,经常使用三种类型的注释:文档型的注释,其一般格式是:以“/**”开头,以“*/”结尾;C语言类型的注释,它通常是以“/*”开头,以“*/”结尾;还有一种是通常用的单行注释的方法,即以“//”开头,对一个单行进行注释。下面以表格的方式,分别说明这三种方式在JAVA中如何更好的使用。芅注释类型蒁使用方式薇例程肅文档型注释莃文档型注释经常用在定义接口,类,成员方法,域的定义之前,不且这种注释可以被通过javadoc直接生成帮助文档。羀/**芇Customer-Acustomerisanypersonor……膆***@*/lassCustomer{}肇C风格型的注释膈当要一次对多行代码进行注释,或者这些代码将不被执行,或者对这些行进行调试时,本注释是一种比较合适的注释方法。袄/*mented..螈…………羅……(thesourcecode)羂*/蒂单行注释薈通常在成员方法内部注释商业逻辑,一小节代码,或者临时变量的声明。肆//