Java语言编程规范(华为公司)
DKBA
华为技术有限公司企业技术规范
DKBAXXXX-2001.12
代替(DKBA200106-003)Java语言编程规范
2001-12-XX发布2001-12-XX实施
华为技术有限公司发布
VVVVVVV VVVVVVVVVVVX。XVX.X VX.X VX.X VX.XVX.X
目次
前
言 .............................................................................. .. (3)
1 范围11
2 规范性引用文件11
3 术语和定义11
4 排版规范12
4.1 规则12
1.*程序块要采用缩进风格编写,缩进
12
的空格数为4个。
12
2.*分界符(如大括号‘{’和‘}’)
应各独占一行并且位于同一列,同时与
引用它们的语句左对齐。在函数体的开
始、类和接口的定义、以及if、for、
do、while、switch、case语句中
的程序都要采用如上的缩进方式。
13
3.*较长的语句、表达式或参数(>80
字符)要分成多行书写,长表达式要在
低优先级操作符处划分新行,操作符放
在新行之首,划分出的新行要进行适当
的缩进,使排版整齐,语句可读。
13
4.*不允许把多个短语句写在一行中,
即一行只写一条语句
5.*if, for, do, while, case,
13
switch, default 等语句自占一行,且
if, for, do, while等语句的执行语句
无论多少都要加括号{}。
6.*相对独立的程序块之间、变量说明
13
之后必须加空行。
7.*对齐只使用空格键,不使用TAB键。14
VVVVVVV VVVVVVVVVVVX。XVX.X VX.X VX.X VX.XVX.X
8.*在两个以上的关键字、变量、常量
14
进行对等操作时,它们之间的操作符之
前、之后或者前后要加空格;进行非对
等操作时,如果是关系密切的立即操作
符(如.),后不应加空格。
4.2 建议15
15
1.类属性和类方法不要交叉放置,不同
存取范围的属性或者方法也尽量不要equals()方法
交叉放置。
5 注释规范16
5.1 规则16
16
1.一般情况下,源程序有效注释量必须
在30%以上。
2.包的注释:包的注释写入一个名为
16
package.html的HTML格式的说明文
件放入当前路径。
3.包的注释内容:简述本包的作用、详
16
细描述本包的内容、产品模块名称和版
本、公司版权。
4.文件注释:文件注释写入文件头部,
16
包名之前的位置。
17
5.文件注释内容:版权说明、描述信息、
生成日期、修改历史。
6.类和接口的注释:该注释放在
18
package 关键字之后,class 或者
interface 关键字之前。
18
7.类和接口的注释内容:类的注释主要
是一句话功能简述、功能详细描述,
8.类属性、公有和保护方法注释:写在
19
类属性、公有和保护方法上面。
9. 成员变量注释内容:成员变量的意
19
义、目的、功能,可能被用到的地方。
10.公有和保护方法注释内容:列出方
19
法的一句话功能简述、功能详细描述、
输入参数、输出参数、返回值、违例等。
VVVVVVV VVVVVVVVVVVX。XVX.X VX.X VX.X VX.XVX.X
20
11.对于方法内部用throw语句抛出的
异常,必须在方法的注释中标明,对于
所调用的其他方法所抛出的异常,选择
主要的在注释中说明。对于非
RuntimeException,即throws子句声明
会抛出的异常,必须在方法的注释中标
明。
12.*注释应与其描述的代码相近,对代
20
码的注释应放在其上方或右方(对单条
语句的注释)相邻位置,不可放在下面,
如放于上方则需与其上面的代码用空
行隔开。
13.*注释与所描述内容进行同样的缩
20
排。
21
14.*将注释与其上面的代码用空行隔
开。
15.*对变量的定义和分支语句(条件分
21
支、循环语句等)必须编写注释。
21
16.*对于switch语句下的case语句,
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论