软件编码规范.doc

Documentnumber文档编号Confidentialitylevel密级内部公开Documentversion文档版本Total37pagesV1.00Java语言编码规范Preparedby拟制Date日期yyyy-mm-ddReviewedby评审人Date日期yyyy-mm-ddApprovedby批准Date日期yyyy-mm-ddRevisionRecord修订记录Date日期RevisionVersion修订版本SecNo.修改章节ChangeDescription修改描述Author作者yyyy-mm-ddVx.xxTableofContents目录1.范围42.规范性引用文献43.术语和定义44.排版规范54.1.规则54.2.建议75.注释规范85.1.规则85.2.建议136.命名规范166.1.规则166.2.建议177.编码规范197.1.规则197.2.建议238.JTEST规范258.1.规则258.2.建议26范围本规范规定了使用Java语言编程时排版、注释、命名、编码和JTEST的规则和建议。本规范合用于使用Java语言编程的产品和项目。规范性引用文献下列文献中的条款通过本规范的引用而成为本规范的条款。凡是注日期的引用文献，其随后所有的修改单（不涉及勘误的内容）或修订版均不合用于本规范，然而，鼓励根据本规范达成协议的各方研究是否可使用这些文献的最新版本。凡是不注日期的引用文献，其最新版本合用于本规范。序号编号名称1《Java语言编程规范》术语和定义规则：编程时强制必须遵守的原则。建议：编程时必须加以考虑的原则。格式：对此规范格式的说明。说明：对此规范或建议进行必要的解释。示例：对此规范或建议从正、反两个方面给出例子。排版规范规则*程序块要采用缩进风格编写，缩进的空格数为4个。说明：对于由开发工具自动生成的代码可以有不一致。*分界符（如大括号‘{’和‘}’）应各独占一行并且位于同一列，同时与引用它们的语句左对齐。在函数体的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。示例：如下例子不符合规范。for(...){...//programcode}if(...){...//programcode}voidexample_fun(void){...//programcode}应如下书写：for(...){...//programcode}if(...){...//programcode}voidexample_fun(void){...//programcode}*较长的语句、表达式或参数（>80字符）要提成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。示例：if(filename!=null&&newFile(logPath+filename).length()<LogConfig.getFileSize()){...//programcode}publicstaticLogIteratorread(StringlogType,DatestartTime,DateendTime,intlogLevel,StringuserName,intbufferNum)*不允许把多个短语句写在一行中，即一行只写一条语句示例：如下例子不符合规范。LogFilenamenow=null;LogFilenamethat=null;应如下书写：LogFilenamenow=null;LogFilenamethat=null;*if,for,do,while,case,switch,default等语句自占一行，且if,for,do,while等语句的执行语句无论多少都要加括号{}。示例：如下例子不符合规范。if(writeToFile)writeFileThread.interrupt();应如下书写：if(writeToFile){writeFileThread.interrupt();}*相对独立的程序块之间、变量说明之后必须加空行。示例：如下例子不符合规范。if(log.getLevel()<LogConfig.getRecordLevel()){return;}LogWriterwriter;应如下书写：if(log.getLevel()<LogConfig.getRecordLevel()){return;}LogWriterwriter;intindex;*对齐只使用空格键，不使用TAB键。说明：以免用不同的编辑器阅读程序时，因TAB键所设立的空格数目不同而导致程序布局不整齐。JBuilder、UltraEdit等编辑环境，支持行首TAB替换成空格，应