Java语言编程规范--华为01年 下载本文

密级: 内部公开

DKBAXXXX-2001.12

排版规范

{

... // program code }

3.

*较长的语句、表达式或参数(>80字符)要分成多行书写,长表

达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。

示例:

if (filename != null

&& new File(logPath + filename).length() < LogConfig.getFileSize()) {

... // program code }

public static LogIterator read(String logType, Date startTime,

endTime,

int logLevel, String userName,

int bufferNum)

4.

*不允许把多个短语句写在一行中,即一行只写一条语句

Date

示例:如下例子不符合规范。

LogFilename now = null; LogFilename that = null; 应如下书写

LogFilename now = null; LogFilename that = null;

5.

*if, for, do, while, case, switch, default 等语句自占一行,且if, for, do, while

等语句的执行语句无论多少都要加括号{}。

示例:如下例子不符合规范。

if(writeToFile) writeFileThread.interrupt();

应如下书写:

2005-10-15, 11:40:39

16

密级: 内部公开

DKBAXXXX-2001.12

排版规范

if(writeToFile) {

writeFileThread.interrupt(); }

6.

*相对独立的程序块之间、变量说明之后必须加空行。

示例:如下例子不符合规范。

if(log.getLevel() < LogConfig.getRecordLevel()) {

return; }

LogWriter writer;

应如下书写

if(log.getLevel() < LogConfig.getRecordLevel()) {

return; }

LogWriter writer; int index;

7.

*对齐只使用空格键,不使用TAB键。

说明:以免用不同的编辑器阅读程序时,因TAB键所设置的空格数目不同而造成程序布局

不整齐。JBuilder、UltraEdit等编辑环境,支持行首TAB替换成空格,应将该选项打

开。

8.

*在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之

前、之后或者前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如.),后不应加空格。

说明:采用这种松散方式编写代码的目的是使代码更加清晰。

2005-10-15, 11:40:39

17

密级: 内部公开

DKBAXXXX-2001.12

排版规范

由于留空格所产生的清晰性是相对的,所以,在已经非常清晰的语句中没有必要再留空

格,如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格,多重括号间不必加空格,因为在Java语言中括号已经是最清晰的标志了。

在长语句中,如果需要加的空格非常多,那么应该保持整体清晰,而在局部不加空格。给

操作符留空格时不要连续留两个以上空格。

示例:

(1) 逗号、分号只在后面加空格。 int a, b, c;

(2)比较操作符, 赋值操作符\、 \,算术操作符\、\,逻辑操作符\、

\,位域操作符\、\等双目操作符的前后加空格。

if (current_time >= MAX_TIME_VALUE) a = b + c; a *= 2; a = b ^ 2;

(3)\、\、\、\、\(地址运算符)等单目操作符前后不加空格。 flag = !isEmpty; // 非操作\与内容之间 i++; // \与内容之间

(4)\前后不加空格。

p.id = pid; // \前后不加空格

(5) if、for、while、switch等与后面的括号间应加空格,使if等关键字更为突出、

明显。

if (a >= b && c > d)

2.2 建议

1.

类属性和类方法不要交叉放置,不同存取范围的属性或者方法也尽量不要

交叉放置。

格式: 类定义 { 2005-10-15, 11:40:39

18

密级: 内部公开

DKBAXXXX-2001.12

类的公有属性定义 类的保护属性定义 类的私有属性定义 类的公有方法定义 类的保护方法定义 类的私有方法定义 } 排版规范

2005-10-15, 11:40:39

19

密级: 内部公开

DKBAXXXX-2001.12

注释规范

3 注释规范 3.1 规则

1.

一般情况下,源程序有效注释量必须在30%以上。

说明:注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不

能太少,注释语言必须准确、易懂、简洁。可以用注释统计工具来统计。

2.

包的注释:包的注释写入一个名为 package.html 的HTML格式的说明文件

放入当前路径。

说明:方便JavaDoc收集 示例:

com/huawei/iin/websmap/comm/package.html

3.

包的注释内容:简述本包的作用、详细描述本包的内容、产品模块

名称和版本、公司版权。

说明:在详细描述中应该说明这个包的作用以及在整个项目中的位置。 格式:

一句话简述。

详细描述。

产品模块名称和版本
公司版权信息 示例:

为 WEBSMAP 提供通信类,上层业务使用本包的通信类与 SMP-B 进行通信。

详细描述。。。。。。。。

2005-10-15, 11:40:39

20