Java编程规范(2010)

《Java编程规范(2010)》由会员上传分享，免费在线阅读，更多相关内容在工程资料-天天文库。

1、Java语言编程规范2010-7-XX发布巅峰软件有限公司前言本规范是参考公司的《软件编程规范总则》和SUN公司《JavaCodingStyleGuide》结合而成的Java语言编程规范。本规范没有涉及到的相关部分，请参见《软件编程规范总则》。Java语言编程规范1范围本规范规定了使用Java语言编程时排版、注释、命名、编码和JTEST的规则和建议。本规范适用于使用Java语言编程的部门和产品。2规范性引用文件下列文件中的条款通过本规范的引用而成为本规范的条款。凡是注日期的引用文件，其随后所有的修

2、改单（不包括勘误的内容）或修订版均不适用于本规范，然而，鼓励根据本规范达成协议的各方研究是否可使用这些文件的最新版本。凡是不注日期的引用文件，其最新版本适用于本规范序号编号名称1公司-0000《软件编程规范总则》同总则的部分使用*号3术语和定义规则：编程时强制必须遵守的原则。建议：编程时必须加以考虑的原则。格式：对此规范格式的说明。说明：对此规范或建议进行必要的解释。示例：对此规范或建议从正、反两个方面给出例子。4排版规范4.1规则1.*程序块要采用缩进风格编写，缩进的空格数为4个。说明：对于由开

3、发工具自动生成的代码可以有不一致。2*分界符（如大括号‘{’和‘}’）应各独占一行并且位于同一列，同时与引用它们的语句左对齐。在函数体的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。示例：如下例子不符合规范。for(...){...//programcode}if(...){...//programcode}voidexample_fun(void){...//programcode}应如下书写。for(...){...//pr

4、ogramcode}if(...){...//programcode}voidexample_fun(void){...//programcode}3*较长的语句、表达式或参数（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。示例：if(filename!=null&&newFile(logPath+filename).length()

5、mcode}publicstaticLogIteratorread(StringlogType,DatestartTime,DateendTime,intlogLevel,StringuserName,intbufferNum)4*不允许把多个短语句写在一行中，即一行只写一条语句示例：如下例子不符合规范。LogFilenamenow=null;LogFilenamethat=null;应如下书写LogFilenamenow=null;LogFilenamethat=null;5*if,for,do

6、,while,case,switch,default等语句自占一行，且if,for,do,while等语句的执行语句无论多少都要加括号{}示例：如下例子不符合规范。if(writeToFile)writeFileThread.interrupt();应如下书写：if(writeToFile){writeFileThread.interrupt();}6*相对独立的程序块之间、变量说明之后必须加空行。示例：如下例子不符合规范。if(log.getLevel()

7、Level()){return;}LogWriterwriter;应如下书写if(log.getLevel()

8、们之间的操作符之前、之后或者前后要加空格；进行非对等操作时，如果是关系密切的立即操作符（如.），后不应加空格。说明：采用这种松散方式编写代码的目的是使代码更加清晰。由于留空格所产生的清晰性是相对的，所以，在已经非常清晰的语句中没有必要再留空格，如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格，多重括号间不必加空格，因为在Java语言中括号已经是最清晰的标志了。在长语句中，如果需要加的空格非常多，那么应该保持整体清晰，而在局部不加空格。给操作符留空格时不要连续留两