java编码规范

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

1、一、JAVA编码规范编码规范概述文件体系结构规则文件命名规则排版规则注释规则命名规则变量方法可读性程序效率质量保证1.编码规范概述制定编码规范的最主要的目的是为了对产出代码的长期维护。通常负责维护代码的人大多都不是开发者本人，如果有一个统一的代码格式以及说明就可以减少混淆提高理解速度。范围编码规范定义了所有代码编写者在编写Java代码时应遵守的一些规则和习惯。本规范采用以下术语描述：规则：编程时强制必须遵守的原则。建议：编程时必须加以考虑的原则。示例：对此规则或建议给出例子。2.文件体系结构规则2.1文件体系

2、规则规则2.1.1JSP文件目录结构

3、――cgi存放cgi程序

4、――cgi-bin存放cgi编译后的程序

5、――css存放样式表

6、――html存放临时生成的报表文件

7、――images存放图片

8、――include存放系统要引用的文件

9、――js存放javascript脚本

10、――ocx存放ocx控件

11、――page存放JSP页面

12、――模块分类名

13、――WEB-INFWEB配置文件，class文件2.文件体系结构规则2.1文件体系规则建议2.1.2Java文件目录结构

14、――<模块分类目录>模块分类

15、――action存放ac

16、tion（控制层）文件

17、――dao存放dao（数据层）文件

18、――form存放form（展示层）文件

19、――service存放业务逻辑文件

20、――vo存放数据对象文件2.文件体系结构规则2.2源文件结构规则规则2.2.1包和引入语句先写包语句，再写引入语句。package行和import行之间留一行空行。引入的标准包名要在本地包名之前，并且包名按照字母顺序排列。如果import行中包含了同一个包中的类超过5个，则用*来处理。import的标准包和本地包之间留一行空行。示例：packagecom.sitech.crm

21、pd.core.codegen;importjava.sql.DatabaseMetaData;importjava.sql.ResultSet;importcom.sitech.crmpd.core.config.Config;importcom.sitech.crmpd.core.jdbc.ConnectionFactory;2.文件体系结构规则2.2源文件结构规则规则2.2.2类/接口先写类/接口注释，标明类/接口的用途、版本、作者等信息。类/接口注释之后空一行，然后写类/接口声明。extends和im

22、plements写在不同行。异常也单写一行。示例：publicclassCounterSetextendsObservableimplementsCloneablethrowsXXXXXX2.文件体系结构规则2.2源文件结构规则规则2.2.3类变量的声明顺序是public,protected,package,private公共变量（Public）保护变量（Protected）包一级别的变量（没有访问修饰符)私有变量（Private）2.文件体系结构规则2.2源文件结构规则规则2.2.4变量、常量的注释应放在其

23、上方相邻位置或右方规则2.2.5用递增的方式写构造器（比如：参数多的写在后面）规则2.2.6类变量的存取方法：get和set方法规则2.2.7如果定义main()方法，必须将main方法写在类的底部3.文件命名规则3.1Struts配制文件命名sc-模块名.xml3.2jsp文件命名模块名_main.jsp主文件模块名_xxx.jspxxx命名详见附录A：词典规范sxxxx文件夹，xxxx为opcodefxxxx_x.jspxxxxopcode，x序号3.3jsp文件命名模块名Action.javaactio

24、n文件模块名Form.javaform文件模块名Svc.javaservice文件表名Dao.javadao文件表名Vo.javavo文件表名PK.java主键的vo文件4.排版规则4.1方法排版规则规则4.1.1方法名和其后的括弧之间不应有空格示例：intgetResult(intforInt,charforChar)规则4.1.2缩进采用4个空格注意：一定要使用空格键。这样可以避免使用不同的编辑器阅读程序时，因TAB键所设置的空格数目不同而造成程序布局不整齐。4.排版规则4.1方法排版规则规则4.1.3在

25、方法的局部变量声明和语句之间加一个空行示例：voidmethod1(){//声明intanInt=0;StringaString=null;ObjectanObj=null;//语句if(condition){…}…}4.排版规则4.1方法排版规则规则4.1.4块注释或单行注释之前必须有一行空行规则4.1.5方法内的两个逻辑段之间必须有一行空行建议4.1.6在方法的每个参数之间的逗号后面加一个空格4