J2EE开发编程规范

Confidential(机密)开发团队内部文件TheinternalfileofVinko’sdevelopmentteamJ2EE开发编程规范J2EEProgramStandardVersion1.0WrittenByAllRightsReservedJ2EE开发编程规范@2009版权所有1版本历史日期版本说明作者1.0J2EE开发编程规范@2009版权所有2目录1.前言..................................................................................................................32.范围..................................................................................................................33.术语和定义.....................................................................................................34.排版规范........................................................................................................................34.1规则............................................................................................................34.2建议............................................................................................................75.注释规范.........................................................................................................75.1规则............................................................................................................75.2建议..........................................................................................................136.命名规范.......................................................................................................156.1JAVA语言...............................................................................................156.1.1规则................................................................................................156.1.2建议................................................................................................176.2JSP/HTML...............................................................................................187.编码规范.......................................................................................................217.1JAVA语言...............................................................................................217.1.1规则................................................................................................217.1.2建议...............................................................................................267.2JSP/HTML...............................................................................................27J2EE开发编程规范@2009版权所有31.前言本规范是为了使J2EE开发过程有章可循，保证软件开发的质量，加强技术的管理，使公司的开发团队更专业及更有效率而制定。2.范围本规范规定了J2EE开发编程时排版、注释、命名和编码的规则和建议。本规范适用于使用Java/JSP语言编程的部门和产品。3.术语和定义规则：编程时强制必须遵守的原则。建议：编程时必须加以考虑的原则。格式：对此规范格式的说明。说明：对此规范或建议进行必要的解释。示例：对此规范或建议给出标准的例子。4.排版规范4.1规则¾程序块要采用缩进风格编写，缩进的空格数为4个。说明：对于由开发工具自动生成的代码可以有不一致。¾import顺序1)jdk标准包2)java扩展包（例如servlet，javamail，jce等）3)使用的外部库的包（例如xmlparser）J2EE开发编程规范@2009版权所有44)使用的项目的公共包5)使用的模块的其他包说明：每一类import后面加一个换行。例如：importjava.io.*;importjava.util.*;importjavax.servlet.*;importjavax.mail.*;importorg.apache.xml.*;importnet.ebseries.*;importnet.ebseries.util.*;importnet.ebseries.ebwebmail.*;¾分界符（如大括号‘{’和‘}’）应各独占一行并且位于同一列，同时与引用它们的语句左对齐。在函数体的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。示例:for(...){...//programcode}if(...){...//programcode}voidexample_fun(void){...//programcode}¾较长的语句、表达式或参数（80字符）要分成多行书写，长表达式要在低J2EE开发编程规范@2009版权所有5优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。示例：if(filename!=null&&newFile(logPath+filename).length()LogConfig.getFileSize()){...//programcode}publicstaticLogIteratorread(StringlogType,DatestartTime,DateendTime,intlogLevel,StringuserName,intbufferNum)¾不允许把多个短语句写在一行中，即一行只写一条语句示例：LogFilenamenow=null;LogFilenamethat=null;¾if,for,do,while,case,switch,default等语句自占一行，且if,for,do,while等语句的执行语句无论多少都要加括号{}。示例：if(writeToFile){writeFileThread.interrupt();}¾相对独立的程序块之间、变量说明之后必须加空行。示例：if(log.getLevel()LogConfig.getRecordLevel()){return;}LogWriterwriter;J2EE开发编程规范@2009版权所有6intindex;¾对齐只使用空格键，不使用TAB键。说明：以免用不同的编辑器阅读程序时，因TAB键所设置的空格数目不同而造成程序布局不整齐。JBuilder、UltraEdit等编辑环境，支持行首TAB替换成空格，应将该选项打开。¾在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者前后要加空格；进行非对等操作时，如果是关系密切的立即操作符（如.），后不应加空格。说明：采用这种松散方式编写代码的目的是使代码更加清晰。由于留空格所产生的清晰性是相对的，所以，在已经非常清晰的语句中没有必要再留空格，如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格，多重括号间不必加空格，因为在Java语言中括号已经是昀清晰的标志了。在长语句中，如果需要加的空格非常多，那么应该保持整体清晰，而在局部不加空格。给操作符留空格时不要连续留两个以上空格。示例：(1)逗号、分号只在后面加空格。inta,b,c;(2)比较操作符,赋值操作符=、+=，算术操作符+、%，逻辑操作符&&、&，位域操作符、^等双目操作符的前后加空格。if(current_time=MAX_TIME_VALUE)a=b+c;a*=2;a=b^2;(3)!、~、++、--、&（地址运算符）等单目操作符前后不加空格。flag=!isEmpty;//非操作!与内容之间i++;//++,--与内容之间J2EE开发编程规范@2009版权所有7(4).前后不加空格。p.id=pid;//.前后不加空格(5)if、for、while、switch等与后面的括号间应加空格，使if等关键字更为突出、明显。if(a=b&&cd)4.2建议类属性和类方法不要交叉放置，不同存取范围的属性或者方法也尽量不要交叉放置。格式：类定义{类的公有属性定义类的保护属性定义类的私有属性定义类的公有方法定义类的保护方法定义类的私有方法定义}5.注释规范5.1规则注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。可以用注释统计工具来统计。¾包的注释内容：简述本包的作用、详细描述本包的内容、产品模块名称和版本、公司版权。说明：在详细描述中应该说明这个包的作用以及在整个项目中的位置。格式：/***一句话简述。J2EE开发编程规范@2009版权所有8*详细描述。*产品模块名称和版本*公司版权信息*/¾文件注释：文件注释写入文件头部，包名之前的位置。示例：/**注释内容*/packagecom.vinko.uttrms.comm;¾文件注释内容：版权说明、描述信息、生成日期、修改历史。格式：/***文件名：[文件名]*版权：〈版权〉*描述：〈描述〉*修改人：〈修改人〉*修改时间：YYYY-MM-DD*修改内容：〈修改内容〉*/说明：每次修改后在文件头部写明修改信息，CheckIn的时候可以直接把蓝色字体信息粘贴到CVS的注释上。示例：/***文件名：LogManager.java*版权：Cop