Java开发规范V1.2 - 图文(3)

第2章 代码组织与风格 2.1 基本原则

代码的组织和风格的基本原则是：便于自己的开发，易于与他人的交流。 因个人习惯和编辑器等可以设臵和形成自己的风格，但必须前后一致，并符合本规范的基本要求和原则。

本章所涉及到的内容一般都可在Java集成编辑环境中进行相应设臵，也可由Ant等调用check style等来进行自动规整。

2.2 缩进

子功能块当在其父功能块后缩进。

当功能块过多而导致缩进过深时当将子功能块提取出来做为子方法。 代码中以TAB（4个字符）缩进，在编辑器中请将TAB设臵为以空格替代，否则在不同编辑器或设臵下会导致TAB长度不等而影响整个程序代码的格式。例如：

缩进示例 : public void methodName(){

2

软件开发项目管理培训

if(some condition){ for(…){ //some sentences }//end for }//end if }

2.3 长度

为便于阅读和理解，单个方法的有效代码长度当尽量控制在100行以内（不包括注释行），当一个功能模块过大时往往造成阅读困难，因此当使用子方法等将相应功能抽取出来，这也有利于提高代码的重用度。

单个类也不宜过大，当出现此类情况时当将相应功能的代码重构到其他类中，通过组合等方式来调用，建议单个类的长度包括注释行不超过1500行。 尽量避免使用大类和长方法。

2.4 行宽

页宽应设臵为80字符。一般不要超过这个宽度, 这会导致在某些机器中无法以一屏来完整显示, 但这一设臵也可以灵活调整。在任何情况下, 超长的语句应该在一个逗号后或一个操作符前折行。一条语句折行后, 应该比原来的语句再缩进一个TAB或4个空格，以便于阅读。

2.5 间隔

类、方法及功能块间等应以空行相隔，以增加可读性，但不得有无规则的大片空行。

操作符两端应当各空一个字符以增加可读性。

相应独立的功能模块之间可使用注释行间隔，并标明相应内容，具体参看附

3

软件开发项目管理培训

录的代码示例 。

2.6 对齐

关系密切的行应对齐，对齐包括类型、修饰、名称、参数等各部分对齐。 连续赋值时当对齐操作符。

当方法参数过多时当在每个参数后（逗号后）换行并对齐。

当控制或循环中的条件比较长时当换行（操作符前）、对齐并注释各条件。 变量定义最好通过添加空格形成对齐，同一类型的变量应放在一起。如下例所示： 对齐示例 ：

//变量对齐----------------------------------------------- int count = 100; int length = 0;

String strUserName = null;

Integer[] porductCode = new Integer(2); //产品编码数组 //参数对齐---------------------------------------------- public Connection getConnection(String url,

String userName, String password)

throws SQLException,IOException{ }

//换行对齐----------------------------------------------

public final static String SQL_SELECT_PRODUCT = ?SELECT * ?

+ ? FROM TProduct WHERE Prod_ID = ? + prodID;

//条件对齐---------------------------------------------- if( Condition1 //当条件一

&& Condition2 //并且条件二

4

软件开发项目管理培训

|| Condition3){ //或者条件三 } for(int i = 0; i < productCount.length; //循环终止条件 i++){ } 2.7 括号

{} 中的语句应该单独作为一行，左括号\当紧跟其语句后，右括号\永远单独作为一行且与其匹配行对齐，并尽量在其后说明其匹配的功能模块。 较长的方法以及类、接口等的右括号后应使用//end ...等标识其结束。如: 类的结束符：}//EOC ClassName， 方法结束符：}//end methodName()， 功能块结束：}//end if...userName is null? 循环快结束：}//end for...every user in userList

不要在程序中出现不必要的括号，但有时为了增加可读性和便于理解，当用括号限定相应项。

左括号是否换行等随个人习惯而定，若换行则当与其前导语句首字符对齐。

2.8代码风格

项目 缩进 代码中以TAB（4个字符）缩进 单个方法的有效代码长度当尽量控制在100行以内；单个类的长度包括长度 注释行不超过1500行 行宽 页宽应该设臵为80字符 间隔 类、方法及功能块间等应以空行（1行）相隔，但不得有无规则的大片

5

原则 软件开发项目管理培训

空行；操作符两端应当各空一个字符 对齐 关系密切的行应对齐，对齐包括类型、修饰、名称、参数等各部分对齐 括号 左括号\当紧跟其语句后，右括号\永远单独作为一行且与其匹配行对齐，并尽量在其后说明其匹配的功能模块 第3章 注释 3.1 基本原则

? 注释应该增加代码的清晰度。代码注释的目的是要使代码更易于被其他开发人员等理解。

? 如果你的程序不值得注释，那么它很可能也不值得运行。 ? 避免使用装饰性内容。 ? 保持注释的简洁。

? 注释信息不仅要包括代码的功能，还应给出原因。 ? 不要为注释而注释。

?

除变量定义等较短语句的注释可用行尾注释外，其他注释当避免使用行

尾注释。

3.2 JavaDoc

对类、方法、变量等的注释需要符合JavaDoc规范，对每个类、方法都应详细说明其功能、条件、参数等，并使用良好的HTML标记格式化注释，以使生成的JavaDoc易阅读和理解。

3.3 文件与包注释

在每个文件、包的头部都应该包含该文件的名称、版本、版权以及创建、修改记录等。注意是/**/注释而不是/***/JavaDoc注释。

6