java代码规范

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

1、归档编号：JAVA代码规范文档编号系统名称建立日期应用分类项H负责定稿曰期2012年10月31日审核人编制人文档说明序号修改日期修改主要内容修改人审核人1.目的规范java程序编码2.范围本规范规定了使用java语言编程时排版、注释、命名和编码的规则和建议。本规范适用于使用java语言编程的产品和项目。3.术语和定义规则编程时强制必须遵守的原则。建议编程时必须加以考虑的原则。格式对此规范格式的说明。说明对此规范或建议进行必要的解释。示例对此规范或建议从正、反两个方面给出例子。4.命名规范4.1规则4.

2、1.1包名采用域名倒罝加上自定义名称，都采用小写字母。建立项目时，确定包名范围，防止后续产生冲突。格式：com.goldtel.功能包名.模块名称示例：日志模块包名com.goldtel.util.log4.1.2类名和接口使用类意义完整的英文描述；每个英文单词的首字母使用大写、其余字母使用小写的大小写混合法。接口(linterface):首字母大写，习惯上名称加后缀able或者er，用来区分类名示例：TrafficServicer,Connectable类(Class)首字母大写不例：Traffic

3、DAO4.1.3方法名使用意义完整英文描述，第一个字母使用小写，剩余单词首字母大写，其余字母小写示例：publicvoidsetAttribute();4.1.4属性名使用意义完整的英文描述，第一个字母使用小写，剩余单词首字母大写，其余字母小写。属性名不能与类名重S示例：privateorderNumber;4.1.1常量名使用全大写英文來描述，英文单同间用下划线隔开，并且使用final,static修饰示例：privatefinalstaticintMAX_VALUE=100;4.2建议4.2.1常

4、用组件类的命名以组件名加上组件类型名结尾示例：bean类型的，以Bean结尾：CartBeanservice类型的，以Service姑尾：LoginService4.2.2如果函数名超过15个字母可采用以去掉元音字母的方法或者以行业内约定俗成的缩写方式缩写函数名。示例：getCustomerlnformation()改为getCustomerlnfo()4.2.3准确使用访问控制域，如不是必须使用public属性的，诘•使用protected示例：publicvoidsetNumber();prote

5、ctedvoidgetMsg();4.2.4含有集合意义的属性命名，尽量包含其复数意义。示例：customers,cartList1.排版规范5.1规则5.1.1程序块要采用缩进风格编写缩进的空格数为4个。说明：对于由开发工具自动生成的代码可以有不一致。写完代码后对代码进行格式化，默认快捷键为Ctrl+Shift+F。5.1.2分界符如大括号‘{’和‘}’应各独占一行并且位于同一列同时与引用它们的语句左对齐。在函数体的开始、类和接口的定义、以及if、for、do、while、switch、case语句

6、屮的程序都要采用如上的缩进方式。示例：if(…){......//programcodefor(...){......//programcode}voidexample(void)•…"//programcode}5.1.3较长的语句、表达式或参数(〉80字符)要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。示例：if(filename!=null&&newFile(logPath+filename)•length()

7、gConfig.getFileSize()){...//programcode}publicstaticLoglteratorread(StringlogType,DatestartTime,DateendTime,intlogLevel,StringuserName,intbufferNum)5.1.4不允许把多个短语句写在一行中即一行只写一条语句。示例：如下例子不符合规范LogFilenamenow=null;LogFilenamethat=null;正确书写格式为：LogFilenamenow=

8、null;LogFilenamethat=null;5.1.5if,for,do,while,case,switch,default等语句自占一行且if,for,do,while等语句的执行语句无论多少都要加括号{}。示例:if(flag>100){number=10;}5.1.6相对独立的程序块之间、变:W:说明之后必须加空行示例：if(flag!=null){......//programcode}LogFileNamenow=null;1.注释规范