文档介绍：华为技术有限公司企业技术规范
DKBA1040-200112
代替（DKBA200106-003）
Java语言编程规范
2001-12-XX发布 2001-12-XX实施
华 为 技 术 有 限 公 司发布
目 次
前言 3
1 范围
11
2 规范性引用文件
11
3 术语和定义
11
4 排版规范
12
41 规则
12
1*程序块要采用缩进风格编写，缩进的空格数为4个。
12
2*分界符（如大括号‘{’和‘}’）应各独占一行并且位于同一列，同时与引用它们的语句左对齐。在函数体的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。
12
3*较长的语句、表达式或参数（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。
13
4*不允许把多个短语句写在一行中，即一行只写一条语句
13
5*if, for, do, while, case, switch, default 等语句自占一行，且if, for, do, while等语句的执行语句无论多少都要加括号{}。
13
6*相对独立的程序块之间、变量说明之后必须加空行。
13
7*对齐只使用空格键，不使用TAB键。
14
8*在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者前后要加空格；进行非对等操作时，如果是关系密切的立即操作符（如），后不应加空格。
14
42 建议
15
1类属性和类方法不要交叉放置，不同存取范围的属性或者方法也尽量不要交叉放置。
15
5 注释规范
16
51 规则
16
1一般情况下，源程序有效注释量必须在30％以上。
16
2包的注释：包的注释写入一个名为 packagehtml 的HTML格式的说明文件放入当前路径。
16
3包的注释内容：简述本包的作用、详细描述本包的内容、产品模块名称和版本、公司版权。
16
4文件注释：文件注释写入文件头部，包名之前的位置。
16
5文件注释内容：版权说明、描述信息、生成日期、修改历史。
17
6类和接口的注释：该注释放在 package 关键字之后，class 或者 interface 关键字之前。
18
7类和接口的注释内容：类的注释主要是一句话功能简述、功能详细描述，
18
8类属性、公有和保护方法注释：写在类属性、公有和保护方法上面。
19
9 成员变量注释内容：成员变量的意义、目的、功能，可能被用到的地方。
19
10公有和保护方法注释内容：列出方法的一句话功能简述、功能详细描述、输入参数、输出参数、返回值、违例等。
19
11对于方法内部用throw语句抛出的异常，必须在方法的注释中标明，对于所调用的其他方法所抛出的异常，选择主要的在注释中说明。 对于非RuntimeException，即throws子句声明会抛出的异常，必须在方法的注释中标明。
20
12*注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开。
20
13*注释与所描述内容进行同样的缩排。
20
14*将注释与其上面的代码用空行隔开。
21
15*对变量的定义和分支语句（条件分支、循环语句等）必须编写注释。
21
16*对于switch语句下的case语句，如果因为特殊情况需要处理完一个case后进入下一个case处理，必须在该case语句处理完、下一个case语句前加上明确的注释。
21
17*边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。
21
18*注释的内容要清楚、明了，含义准确，防止注释二义性。
21
19*避免在注释中使用缩写，特别是不常用缩写。
21
51 建议
21
1*避免在一行代码或表达式的中间插入注释。
22
2*通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构，使代码成为自注释的。
22
3*在代码的功能、意图层次上进行注释，提供有用、额外的信息。
22
4*在程序块的结束行右方加注释标记，以表明某程序块的结束。
22
5*注释应考虑程序易读及外观排版的因素，使用的语言若是中、英兼有的，建议多使用中文，除非能用非常流利准确的英文表达。
22
6方法内的单行注释使用 //