JAVA程规范_尹著.docVIP

Java 编程规范 排版 规则 程序块要采用缩进风格编写，缩进的空格数为4个，不允许使用TAB缩进。(1.42+) 说明：缩进使程序更易阅读，使用空格缩进可以适应不同操作系统与不同开发工具。 分界符（如大括号‘{’和‘}’）应各独占一行，同时与引用它们的语句左对齐。在函数体的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程序或者static、,synchronized等语句块中都要采用如上的缩进方式。(1.42+) 示例: if (ab) { doStart(); } 较长的语句、表达式或参数（80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。(1.42+) 示例： if (logger.isDebugEnabled()) { logger.debug(Session destroyed,call-id + event.getSession().getCallId()); } 不允许把多个短语句写在一行中，即一行只写一条语句(1.42+) 说明：阅读代码更加清晰 示例：如下例子不符合规范。 Object o = new Object(); Object b = null; if, for, do, while, case, switch, default 等语句自占一行，且if, for, do, while,switch等语句的执行语句无论多少都要加括号{},case 的执行语句中如果定义变量必须加括号{}。(1.42+) 说明：阅读代码更加清晰，减少错误产生 示例： if (ab) { doStart(); } case x: { int i = 9; } 相对独立的程序块之间、变量说明之后必须加空行。 (1.42+) 说明:阅读代码更加清晰 示例： if(a b) { doStart(); } //此处是空行 return; 在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者前后要加空格；进行非对等操作时，如果是关系密切的立即操作符（如.），后不应加空格。(1.42+) 说明：阅读代码更加清晰 示例： if (a == b) { objectA.doStart(); } a *= 2; 建议 类属性和类方法不要交叉放置，不同存取范围的属性或者方法也尽量不要交叉放置。(1.42+) 格式： 类定义 { 类的公有属性定义 类的保护属性定义 类的私有属性定义 类的公有方法定义 类的保护方法定义 类的私有方法定义 } 修饰词按照指定顺序书写：[访问权限][static][final] 。(1.42+) 示例： public static final String str = “abc”; 注释 规则 源程序注释量必须在30％以上。(1.42+) 说明：由于每个文件的代码注释不一定都可以达到30%，建议以一个系统内部模块作为单位进行检查 包的注释：写入一个名为 package.html 的HTML格式的说明文件放入包所在路径。包的注释内容：简述本包的作用、详细描述本包的内容、产品模块名称和版本、公司版权。(1.42+) 说明：方便JavaDoc收集，方便对包的了解 示例： com/hc/iin/websmap/comm/package.html html body p一句话简述。 p详细描述。 p产品模块名称和版本 br公司版权信息 /body /html 示例： html body P为 WEBSMAP 提供通信类，上层业务使用本包的通信类与 SMP-B 进行通信。 p详细描述。。。。。。。。 pIIN V100R001 WEBSMAP br(C) 版权所有 2000-2001 华为技术有限公司 /body /html 类和接口的注释放在class 或者 interface 关键字之前，import 关键字之后。注释主要是一句话功能简述与功能详细描述。类注释使用“/** */”注释方式(1.42+) 说明：方便JavaDoc收集,没有import可放在package之后。注释可根据需要列出：作者、内容、功能、与其它类的关系等。功能详细描述部分说明该类或者接口的功能、作用、使用方法和注意事项，每次修改后增加作者和更新版本号和日期，@since 表示从那个版本开始就有这个类或者接口，@deprecated 表示不建议使用该类或者接口。 /**