JAVA编程规范【整理】.doc

《JAVA编程规范【整理】.doc》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、Java编程规范目录1概述31.1编写目的31.2面向人员31.3说明32Java编程规范32.1排版规范32.1.1规则32.1.2建议42.2注释规范52.2.1规则52.2.2建议82.3命名规范92.3.1规则92.3.2建议112.4编码规范122.4.1规则122.4.2建议152.5性能与可靠性172.5.1规则172.5.2建议192.6界面设计规范192.6.1规则192.7SQL编码规范202.7.1SQL语句格式202.7.2SQL性能优化222.8其他常见问题302.8.1条件回显302.8.2父页面刷新3

2、12.8.3用户状态313附录313.1Eclipse风格313.2Eclipse注释模板311概述1.1编写目的为了指导开发人员在项目的开发过程中能够统一规范，统一风格，提高代码的可读性和可维护行，提高软件开发质量，特编写本开发规范。规范中有些内容是强制遵守的，有些不一定要绝对遵守，但是一定要让程序有良好的可读性。此规范并非最终文档。1.2面向人员本开发规范适用于应用软件开发的所有开发人员、测试人员。1.3说明本规范分为规则和建议两部分，规则为必须遵守，建议为参考。2Java编程规范2.1排版规范2.1.1规则规则1程序块要采用

3、缩进风格编写，缩进的空格数为4个，不允许使用TAB缩进。说明：缩进使程序更易阅读，使用空格缩进可以适应不同操作系统与不同开发工具。规则2左分界符（‘{’）位于行尾，右分界符（‘}’）应独占一行，同时与引用它的语句左对齐。在函数体的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程序或者static、synchronized等语句块中都要采用如上的缩进方式。示例:if(a>b){doStart();}规则3较长的语句、表达式或参数（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新

4、行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。示例：if(logger.isDebugEnabled()){logger.debug("Sessiondestroyed,call-id"+event.getSession().getCallId());}规则4不允许把多个短语句写在一行中，即一行只写一条语句说明：阅读代码更加清晰示例：如下例子不符合规范。Objecto=newObject();Objectb=null;规则1if,for,do,while,case,switch,default等语句自

5、占一行，且if,for,do,while,switch等语句的执行语句无论多少都要加括号{},case的执行语句中如果定义变量必须加括号{}。说明：阅读代码更加清晰，减少错误产生示例：if(a>b){doStart();}casex:{inti=9;}规则2相对独立的程序块之间、变量说明之后必须加空行。说明:阅读代码更加清晰示例：if(a>b){doStart();}//此处是空行return;规则3在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者前后要加空格；进行非对等操作时，如果是关系密切的立即操作

6、符（如.），后不应加空格。说明：阅读代码更加清晰示例：if(a==b){objectA.doStart();}a*=2;1.1.1建议建议1类属性和类方法不要交叉放置，不同存取范围的属性或者方法也尽量不要交叉放置。格式：类定义{类的公有属性定义类的保护属性定义类的私有属性定义类的公有方法定义类的保护方法定义类的私有方法定义}建议1修饰词按照指定顺序书写：[访问权限][static][final]。示例：publicstaticfinalStringstr=“abc”;1.1注释规范1.1.1规则规则1源程序注释量必须在30％以上。

7、说明：由于每个文件的代码注释不一定都可以达到30%，建议以一个系统内部模块作为单位进行检查规则1类和接口的注释放在import关键字之前。注释主要是一句话功能简述与功能详细描述。类注释使用“/***/”注释方式说明：方便JavaDoc收集,没有import可放在package之后。注释可根据需要列出：作者、内容、功能、与其它类的关系等。功能详细描述部分说明该类或者接口的功能、作用、使用方法和注意事项，每次修改后增加作者和更新版本号和日期，@since表示从那个版本开始就有这个类或者接口，@deprecated表示不建议使用该类或者

8、接口。/***〈一句话功能简述〉*〈功能详细描述〉*@author[作者]（必须）*@see[相关类/方法]（可选）*@since[产品/模块版本]（必须）*@deprecated（可选）*/示例：packagecom.compay.iin.log