《JAVA编程规范_尹著》由会员分享，可在线阅读，更多相关《JAVA编程规范_尹著（17页珍藏版）》请在金锄头文库上搜索。
1、密级:内部公开1 Java 编程规范 1.1 排版1.1.1 规则规则1 程序块要采用缩进风格编写，缩进的空格数为4个，不允许使用TAB缩进。(1.42+)说明：缩进使程序更易阅读，使用空格缩进可以适应不同操作系统与不同开发工具。规则2 分界符（如大括号和）应各独占一行，同时与引用它们的语句左对齐。在函数体的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程序或者static、,synchronized等语句块中都要采用如上的缩进方式。(1.42+)示例:if (ab) doStart();规则3 较长的语句、表达式或参数（80字符）要分成多行书写，长表
2、达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。(1.42+)示例： if (logger.isDebugEnabled() logger.debug(Session destroyed,call-id + event.getSession().getCallId(); 规则4 不允许把多个短语句写在一行中，即一行只写一条语句(1.42+)说明：阅读代码更加清晰 示例：如下例子不符合规范。Object o = new Object(); Object b = null;规则5 if, for, do, while, case, swit
3、ch, default 等语句自占一行，且if, for, do, while,switch等语句的执行语句无论多少都要加括号,case 的执行语句中如果定义变量必须加括号。(1.42+)说明：阅读代码更加清晰，减少错误产生示例：if (ab) doStart();case x: int i = 9; 规则6 相对独立的程序块之间、变量说明之后必须加空行。 (1.42+)说明:阅读代码更加清晰示例：if(a b) doStart();/此处是空行return;规则7 在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者前后要加空格；进行非对等操作时，如果是关系密切的立即
4、操作符（如.），后不应加空格。(1.42+)说明：阅读代码更加清晰示例：if (a = b) objectA.doStart();a *= 2;1.1.2 建议建议1 类属性和类方法不要交叉放置，不同存取范围的属性或者方法也尽量不要交叉放置。(1.42+)格式：类定义 类的公有属性定义 类的保护属性定义 类的私有属性定义 类的公有方法定义 类的保护方法定义 类的私有方法定义建议2 修饰词按照指定顺序书写：访问权限staticfinal 。(1.42+)示例：public static final String str = “abc”;1.2 注释1.2.1 规则规则1 源程序注释量必须在30以
5、上。(1.42+)说明：由于每个文件的代码注释不一定都可以达到30%，建议以一个系统内部模块作为单位进行检查 规则2 包的注释：写入一个名为 package.html 的HTML格式的说明文件放入包所在路径。包的注释内容：简述本包的作用、详细描述本包的内容、产品模块名称和版本、公司版权。(1.42+)说明：方便JavaDoc收集，方便对包的了解示例：com/hc/iin/websmap/comm/package.html一句话简述。详细描述。产品模块名称和版本公司版权信息示例：为 WEBSMAP 提供通信类，上层业务使用本包的通信类与 SMP-B 进行通信。详细描述。IIN V100R001
6、WEBSMAP(C) 版权所有 2000-2001 华为技术有限公司规则3 类和接口的注释放在class 或者 interface 关键字之前，import 关键字之后。注释主要是一句话功能简述与功能详细描述。类注释使用“/* */”注释方式(1.42+)说明：方便JavaDoc收集,没有import可放在package之后。注释可根据需要列出：作者、内容、功能、与其它类的关系等。功能详细描述部分说明该类或者接口的功能、作用、使用方法和注意事项，每次修改后增加作者和更新版本号和日期，since 表示从那个版本开始就有这个类或者接口，deprecated 表示不建议使用该类或者接口。/* * 一
7、句话功能简述 * 功能详细描述 * author 作者（必须）* see 相关类/方法（可选） * since 产品/模块版本 （必须） * deprecated （可选） */示例：package m;import java.util.*;/* * LogManager 类集中控制对日志读写的操作。 * 全部为静态变量和静态方法，对外提供统一接口。分配对应日志类型的读写器， * 读取或写入符合条件的日志纪录。 * author 张三，李四，王五* see LogIteraotor * see BasicLog * since CommonLog1.0 */public class LogMa
8、nager规则4 类属性(成员变量)、公有和保护方法注释：写在类属性、公有和保护方法上面，注释方式为“/* */”.(1.42+)示例：/* * 注释内容 */private String logType;/* * 注释内容 */public void write()规则5 公有和保护方法注释内容：列出方法的一句话功能简述、功能详细描述、输入参数、输出参数、返回值、异常等。(1.42+)格式：/* * 一句话功能简述 * 功能详细描述 * param 参数1 参数1说明 * param 参数2 参数2说明 * return 返回类型说明 * exception/throws 异常类型 异常说明
9、 可选 * see 类、类#方法、类#成员* since 起始版本 * deprecated */说明：since 表示从那个版本开始就有这个方法，如果是最初版本就存在的方法无需说明；exception或throws 列出可能仍出的异常；deprecated 表示不建议使用该方法。示例： /* * 根据日志类型和时间读取日志。 * 分配对应日志类型的LogReader， 指定类型、查询时间段、条件和反复器缓冲数， * 读取日志记录。查询条件为null或0的表示没有限制，反复器缓冲数为0读不到日志。 * 查询时间为左包含原则，即 startTime, endTime) 。 * param log
10、TypeName 日志类型名（在配置文件中定义的） * param startTime 查询日志的开始时间 * param endTime 查询日志的结束时间 * param logLevel 查询日志的级别 * param userName 查询该用户的日志 * param bufferNum 日志反复器缓冲记录数 * return 结果集，日志反复器 * since 1.2 */ public static LogIterator read(String logType, Date startTime,Date endTime, int logLevel, String userName,
11、 int bufferNum)规则6 注释应与其描述的代码相近，对代码的注释应放在其上方，并与其上面的代码用空行隔开，注释与所描述内容进行同样的缩排。(1.42+)说明：可使程序排版整齐，并方便注释的阅读与理解。示例： /* * 注释*/public void example2( ) / 注释 CodeBlock One / 注释 CodeBlock Two/* * 注释*/public void example( ) / 注释 CodeBlock One / 注释 CodeBlock Two规则7 对于switch语句下的case语句，必须在每个case分支结束前加上break语句。(1.4
12、2+)说明：break才能真正表示该switch执行结束，不然可能会进入该case以后的分支。至于语法上合法的场景“一个case后进入下一个case处理”，应该在编码设计上就避免。规则8 修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。(1.42+)规则9 注释的内容要清楚、明了，含义准确，防止注释二义性。(1.42+)说明：错误的注释不但无益反而有害。规则10 避免在注释中使用缩写，特别是不常用缩写。(1.42+)说明：在使用缩写时或之前，应对缩写进行必要的说明。规则11 对重载父类的方法必须进行Override声明(5.0+)说明：可清楚说明此方法是重载父类的方
13、法，保证重载父类的方法时不会因为单词写错而造成错误(写错方法名或者参数个数，类型都会编译无法通过)示例：Overridepublic void doRequest(SipServletRequest req) throws ServletException,IOException1.2.2 建议建议1 避免在一行代码或表达式的中间插入注释。(1.42+)说明：除非必要，不应在代码或表达中间插入注释，否则容易使代码可理解性变差。建议2 在代码的功能、意图层次上进行注释，提供有用、额外的信息。(1.42+)说明：注释的目的是解释代码的目的、功能和采用的方法，提供代码以外的信息，帮助读者理解代码，防止没必要的重复注释信息。示例：如下注释意义不大。/ 如果 receiveFlag 为真if (receiveFlag)而如下的注释则给出了额外有用的信息。 / 如果从连结收到消息 if (rece
