《JAVA编程规范【整理】》由会员分享，可在线阅读，更多相关《JAVA编程规范【整理】（24页珍藏版）》请在金锄头文库上搜索。
1、Java 编程规范目录1概述31.1编写目的31.2面向人员31.3说明32Java编程规范32.1排版规范3规则3建议42.2注释规范5规则5建议82.3命名规范9规则9建议112.4编码规范12规则12建议152.5性能与可靠性17规则17建议192.6界面设计规范19规则192.7SQL编码规范20SQL语句格式20SQL性能优化222.8其他常见问题30条件回显30父页面刷新31用户状态313附录313.1Eclipse 风格313.2Eclipse 注释模板311 概述1.1 编写目的为了指导开发人员在项目的开发过程中能够统一规范，统一风格，提高代码的可读性和可维护行，提高软件开发质
2、量，特编写本开发规范。规范中有些内容是强制遵守的，有些不一定要绝对遵守，但是一定要让程序有良好的可读性。此规范并非最终文档。1.2 面向人员本开发规范适用于应用软件开发的所有开发人员、测试人员。1.3 说明本规范分为规则和建议两部分，规则为必须遵守，建议为参考。2 Java编程规范2.1 排版规范2.1.1 规则规则1 程序块要采用缩进风格编写，缩进的空格数为4个，不允许使用TAB缩进。说明：缩进使程序更易阅读，使用空格缩进可以适应不同操作系统与不同开发工具。规则2 左分界符（）位于行尾，右分界符（）应独占一行，同时与引用它的语句左对齐。在函数体的开始、类和接口的定义、以及if、for、do、
3、while、switch、case语句中的程序或者static、synchronized等语句块中都要采用如上的缩进方式。示例:if(ab) doStart();规则3 较长的语句、表达式或参数（80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。示例：if (logger.isDebugEnabled() logger.debug(Session destroyed,call-id + event.getSession().getCallId(); 规则4 不允许把多个短语句写在一行中，即一行只写一条语句说明
4、：阅读代码更加清晰示例：如下例子不符合规范。Object o = new Object(); Object b = null;规则5 if, for, do, while, case, switch, default 等语句自占一行，且if, for, do, while,switch等语句的执行语句无论多少都要加括号,case 的执行语句中如果定义变量必须加括号。说明：阅读代码更加清晰，减少错误产生示例：if(ab)doStart();case x:int i = 9;规则6 相对独立的程序块之间、变量说明之后必须加空行。说明:阅读代码更加清晰示例：if(ab)doStart();/此处是空
5、行return;规则7 在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者前后要加空格；进行非对等操作时，如果是关系密切的立即操作符（如.），后不应加空格。说明：阅读代码更加清晰示例：if(a = b)objectA.doStart();a *= 2;2.1.2 建议建议1 类属性和类方法不要交叉放置，不同存取范围的属性或者方法也尽量不要交叉放置。格式：类定义类的公有属性定义类的保护属性定义类的私有属性定义类的公有方法定义类的保护方法定义类的私有方法定义建议2 修饰词按照指定顺序书写：访问权限staticfinal。示例：public static final Str
6、ing str = “abc”;2.2 注释规范2.2.1 规则规则1 源程序注释量必须在30以上。说明：由于每个文件的代码注释不一定都可以达到30%，建议以一个系统内部模块作为单位进行检查规则2 类和接口的注释放在import 关键字之前。注释主要是一句话功能简述与功能详细描述。类注释使用“/* */”注释方式说明：方便JavaDoc收集,没有import可放在package之后。注释可根据需要列出：作者、内容、功能、与其它类的关系等。功能详细描述部分说明该类或者接口的功能、作用、使用方法和注意事项，每次修改后增加作者和更新版本号和日期，since 表示从那个版本开始就有这个类或者接口，de
7、precated 表示不建议使用该类或者接口。/* * 一句话功能简述 * 功能详细描述 * author 作者（必须）* see 相关类/方法（可选） * since 产品/模块版本 （必须） * deprecated （可选） */示例：package com pay.iin.logwebsmap m;import java.util.*;/* * LogManager 类集中控制对日志读写的操作。 * 全部为静态变量和静态方法，对外提供统一接口。分配对应日志类型的读写器， * 读取或写入符合条件的日志纪录。 * author 张三，李四，王五* see LogIteraotor * se
8、e BasicLog * since CommonLog1.0 */public class LogManager规则3 类属性(成员变量)、公有和保护方法注释：写在类属性、公有和保护方法上面，注释方式为“/* */”.示例：/* * 注释内容 */private String logType;/* * 注释内容 */public void write()规则4 公有和保护方法注释内容：列出方法的一句话功能简述、功能详细描述、输入参数、输出参数、返回值、异常等。格式：/* * 一句话功能简述 * 功能详细描述 * param 参数1 参数1说明 * param 参数2 参数2说明 * retu
9、rn 返回类型说明 * exception/throws 异常类型 异常说明 * see 类、类#方法、类#成员* since 起始版本 * deprecated */说明：since 表示从那个版本开始就有这个方法，如果是最初版本就存在的方法无需说明；exception或throws 列出可能仍出的异常；deprecated 表示不建议使用该方法。示例： /* * 根据日志类型和时间读取日志。 * 分配对应日志类型的LogReader，指定类型、查询时间段、条件和反复器缓冲数， * 读取日志记录。查询条件为null或0的表示没有限制，反复器缓冲数为0读不到日志。 * 查询时间为左包含原则，即
10、 startTime, endTime) 。 * param logTypeName 日志类型名（在配置文件中定义的） * param startTime 查询日志的开始时间 * param endTime 查询日志的结束时间 * param logLevel 查询日志的级别 * param userName 查询该用户的日志 * param bufferNum 日志反复器缓冲记录数 * return 结果集，日志反复器 * since 1.2 */ public static LogIterator read(String logType, Date startTime,Date endTi
11、me,int logLevel, String userName, int bufferNum)规则5 对于方法内部用throw语句抛出的异常，必须在方法的注释中标明，对于所调用的其他方法所抛出的异常，选择主要的在注释中说明。对于非RuntimeException，即throws子句声明会抛出的异常，必须在方法的注释中标明。说明：异常注释用exception或throws表示，在JavaDoc中两者等价，但推荐用exception标注Runtime异常，throws标注非Runtime异常。异常的注释必须说明该异常的含义及什么条件下抛出该异常。规则6 注释应与其描述的代码相近，对代码的注释应放
12、在其上方，并与其上面的代码用空行隔开，注释与所描述内容进行同样的缩排。说明：可使程序排版整齐，并方便注释的阅读与理解。示例：/* * 注释*/public void example2( ) / 注释 CodeBlock One / 注释 CodeBlock Two/* * 注释*/public void example( ) / 注释 CodeBlock One / 注释 CodeBlock Two规则7 修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。规则8 注释的内容要清楚、明了，含义准确，防止注释二义性。说明：错误的注释不但无益反而有害。规则9 避免在注释中使
13、用缩写，特别是不常用缩写。说明：在使用缩写时或之前，应对缩写进行必要的说明。2.2.2 建议建议1 避免在一行代码或表达式的中间插入注释。说明：除非必要，不应在代码或表达中间插入注释，否则容易使代码可理解性变差。建议2 在代码的功能、意图层次上进行注释，提供有用、额外的信息。说明：注释的目的是解释代码的目的、功能和采用的方法，提供代码以外的信息，帮助读者理解代码，防止没必要的重复注释信息。示例：如下注释意义不大。/ 如果 receiveFlag 为真if (receiveFlag)而如下的注释则给出了额外有用的信息。/ 如果从连结收到消息if (receiveFlag)建议3 对关键变量的定义
14、和分支语句（条件分支、循环语句等）必须编写注释。说明：这些语句往往是程序实现某一特定功能的关键，对于维护人员来说，良好的注释帮助更好的理解程序，有时甚至优于看设计文档。建议4 注释应考虑程序易读及外观排版的因素，使用的语言若是中、英兼有的，建议多使用中文，除非能用非常流利准确的英文表达。中文注释中需使用中文标点。方法和类描述的第一句话尽量使用简洁明了的话概括一下功能，然后加以句号。接下来的部分可以详细描述。说明：注释语言不统一，影响程序易读性和外观排版，出于对维护人员的考虑，建议使用中文。JavaDoc工具收集简介的时候使用选取第一句话。建议5 方法内的单行注释使用 /。说明：调试程序的时候可以方便的使用 /* 。
