当前位置:文档之家› Java语言编程规范(华为公司)

Java语言编程规范(华为公司)

Java语言编程规范(华为公司)
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.类属性和类方法不要交叉放置,不同

存取范围的属性或者方法也尽量不要

交叉放置。

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语句,

如果因为特殊情况需要处理完一个

case后进入下一个case处理,必须在

该case语句处理完、下一个case语句

前加上明确的注释。

17.*边写代码边注释,修改代码同时修

21

改相应的注释,以保证注释与代码的一

致性。不再有用的注释要删除。

21

18.*注释的内容要清楚、明了,含义准

确,防止注释二义性。

21

19.*避免在注释中使用缩写,特别是不

常用缩写。

5.1 建议21

1.*避免在一行代码或表达式的中间插

22

入注释。

22

2.*通过对函数或过程、变量、结构等正确

的命名以及合理地组织代码的结构,使代

码成为自注释的。

22

3.*在代码的功能、意图层次上进行注

释,提供有用、额外的信息。

VVVVVVV VVVVVVVVVVVX。XVX.X VX.X VX.X VX.XVX.X

4.*在程序块的结束行右方加注释标

22

记,以表明某程序块的结束。

22

5.*注释应考虑程序易读及外观排版的

因素,使用的语言若是中、英兼有的,

建议多使用中文,除非能用非常流利准

确的英文表达。

6.方法内的单行注释使用 //。22

23

7.注释尽量使用中文注释和中文标点。

方法和类描述的第一句话尽量使用简

洁明了的话概括一下功能,然后加以句

号。接下来的部分可以详细描述。

23

8.顺序实现流程的说明使用1、2、3、4

在每个实现步骤部分的代码前面进行

注释。

9. 一些复杂的代码需要说明。23 6 命名规范24

6.1 规则24

1.包名采用域后缀倒置的加上自定义

24

的包名,采用小写字母。在部门内部应

该规划好包名的范围,防止产生冲突。

部门内部产品使用部门的名称加上模

块名称。产品线的产品使用产品的名称

加上模块的名称。

2.类名和接口使用类意义完整的英文

24

描述,每个英文单词的首字母使用大

写、其余字母使用小写的大小写混合

法。

3.方法名使用类意义完整的英文描述:

24

第一个单词的字母使用小写、剩余单词

首字母大写其余字母小写的大小写混

合法。

24

4.方法中,存取属性的方法采用setter

和 getter方法,动作方法采用动词和

动宾结构。

VVVVVVV VVVVVVVVVVVX。XVX.X VX.X VX.X VX.XVX.X

5.属性名使用意义完整的英文描述:第

25

一个单词的字母使用小写、剩余单词首

字母大写其余字母小写的大小写混合

法。属性名不能与方法名相同。

25

6.常量名使用全大写的英文描述,英文

单词之间用下划线分隔开,并且使用

final static 修饰。

25

7.属性名可以和公有方法参数相同,不

能和局部变量相同,引用非静态成员变

量时使用 this 引用,引用静态成员变

量时使用类名引用。

6.2 建议25

25

1.常用组件类的命名以组件名加上组

件类型名结尾。

26

2.如果函数名超过15 个字母,可采用

以去掉元音字母的方法或者以行业内

约定俗成的缩写方式缩写函数名。

26

3.准确地确定成员函数的存取控制符

号,不是必须使用 public 属性的,请

使用 protected,不是必须使用

protected, 请使用 private。

4.含有集合意义的属性命名,尽量包含

26

其复数的意义。

7 编码规范27

7.1 规则27

27

1.*明确方法功能,精确(而不是近似)

地实现方法设计。一个函数仅完成一件

功能,即使简单功能也应该编写方法实

现。

2.应明确规定对接口方法参数的合法

27

性检查应由方法的调用者负责还是由

接口方法本身负责,缺省是由方法调用

者负责。

3.明确类的功能,精确(而不是近似)

27

地实现类的设计。一个类仅实现一组相

近的功能。

27

4.所有的数据类必须重载toString()

方法,返回该类有意义的内容。

VVVVVVV VVVVVVVVVVVX。XVX.X VX.X VX.X VX.XVX.X

5.数据库操作、IO操作等需要使用结束

27

close()的对象必须在try

-catch-finally 的finally中

close()。

28

6.异常捕获后,如果不对该异常进行处

理,则应该纪录日志或者

ex.printStackTrace() 。

28

7.自己抛出的异常必须要填写详细的

描述信息。

8.运行期异常使用RuntimeException

29

的子类来表示,不用在可能抛出异常的

方法声明上加throws子句。非运行期异

常是从Exception继承而来的,必须在

方法声明上加throws子句。

29

9.在程序中使用异常处理还是使用错

误返回码处理,根据是否有利于程序结

构来确定,并且异常和错误码不应该混

合使用,推荐使用异常。

29

10.*注意运算符的优先级,并用括号明

确表达式的操作顺序,避免使用默认优

先级。

29

11.*避免使用不易理解的数字,用有意

义的标识来替代。涉及物理状态或者含

有物理意义的常量,不应直接使用数

字,必须用有意义的静态变量来代替。

30

12.数组声明的时候使用 int[]

index ,而不要使用 int

index[] 。

30

13.调试代码的时候,不要使用

System.out 和 System.err 进行打

印,应该使用一个包含统一开关的测试

类进行统一打印。

30

14.用调测开关来切换软件的DEBUG版

和正式版,而不要同时存在正式版本和

DEBUG版本的不同源文件,以减少维护

的难度。

7.2建议30

VVVVVVV VVVVVVVVVVVX。XVX.X VX.X VX.X VX.XVX.X

30

1.记录异常不要保存

exception.getMessage(),而要记录

exception.toString()。

2.一个方法不应抛出太多类型的异常。31

3.异常捕获尽量不要直接 catch

31

(Exception ex),应该把异常细分处

理。

31

4.*如果多段代码重复做同一件事情,

那么在方法的划分上可能存在问题。

5.对于创建的主要的类,最好置入

31

main()函数,包含用于测试那个类的代

码。

31

6.集合中的数据如果不使用了应该及

时释放,尤其是可重复使用的集合。

31

7.*源程序中关系较为紧密的代码应尽

可能相邻。

31

8.*不要使用难懂的技巧性很高的语

句,除非很有必要时。

8 JTEST规范32

8.1 规则(1-2 级)32

32

1.在switch 中每个 case 语句都应该

包含 break 或者 return 。

32

2.不要使用空的for 、if 、while 语

句。

3.在运算中不要减小数据的精度。32

32

4.switch 语句中的 case 关键字要和

后面的常量保持一个空格,switch 语

句中不要定义case 之外的无用标签。

5.不要在if 语句中使用等号= 进行赋

32

值操作。

6.静态成员或者方法使用类名访问,不

32

使用句柄访问。

7.方法重载的时候,一定要注意方法名

32

相同,避免类中使用两个非常相似的方

法名。

VVVVVVV VVVVVVVVVVVX。XVX.X VX.X VX.X VX.XVX.X

8.不要在

32

https://www.doczj.com/doc/0318126121.html,ponentResize

d() 方法中调用 serResize() 方法。

32

9.不要覆盖父类的静态方法和私有方

法。

10.不要覆盖父类的属性。32

11.不要使用两级以上的内部类。32

12.把内部类定义成私有类。32

32

13.去掉接口中多余的定义(不使用

public, abstract, static, final

等,这是接口中默认的)。

32

14.不要定义不会被用到的局部变量、

类私有属性、类私有方法和方法参数。

15.显式初始化所有的静态属性。32

16.不要使用 System.getenv() 方法。32

17.不要硬编码‘\n’和‘\r’作为换

32

行符号。

32

18.不要直接使用 java.awt.peer.*

里面的接口。

32

19.使用 System.arraycopy() ,不使

用循环来复制数组。

32

20.避免不必要的 instanceof 比较运

算和类造型运算。

32

21.不要在 finalize() 方法中删除监

听器(Listeners)。

32

22.在 finalize() 方法中一定要调用

super.finalize() 方法。

32

23.在 finalize() 方法中的 finally

中调用 super.finalize() 方法。

32

24.进行字符转换的时候应该尽可能的

较少临时变量。

32

25.使用ObjectStream 的方法后,调用

reset() ,释放对象。

32

26.线程同步中,在循环里面使用条件

测试(使用 while(isWait) wait() 代

替 if(isWait) wait())。

VVVVVVV VVVVVVVVVVVX。XVX.X VX.X VX.X VX.XVX.X

32

27.不掉用 Thread 类的 resume(),

suspend(), stop() 方法。

28.减小单个方法的复杂度,使用的

32

if, while, for, switch 语句要在10

个以内。

29.在Servlets中,重用JDBC连接的数

32

据源。

30.减少在Sevlets中使用的同步方法。32

32

31.不定义在包中没有被用到的友好属

性、方法和类。

32.没有子类的友好类应该定义成

32

final 。

32

33.没有被覆盖的友好方法应该定义成

final 。

8.2 建议(3级或以上)33

33

1.为 switch 语句提供一个 default

选项。

33

2.不要在 for 循环体中对计数器的赋

值。

3.不要给非公有类定义 public 构建

33

器。

33

4.不要对浮点数进行比较运算,尤其是

不要进行 ==, !=运算,减少 >, < 运

算。

33

5.实现 equals() 方法时,先用

getClass() 或者 instanceof 进行类

型比较,通过后才能继续比较。

33

6.不要重载 main() 方法用作除入口

以外的其他用途。

7.方法的参数名不要和类中的方法名

33

相同。

33

8.除了构建器外,不要使用和类名相同

的方法名。

9.不要定义 Error 和

33

RuntimeException 的子类,可以定义

Exception 的子类。

10.线程中需要实现 run() 方法。33

VVVVVVV VVVVVVVVVVVX。XVX.X VX.X VX.X VX.XVX.X

11.使用 equals() 比较两个类的值是

33

否相同。

33

12.字符串和数字运算结果相连接的时

候,应该把数字运算部分用小括号括起

来。

13.类中不要使用非私有(公有、保护

33

和友好)的非静态属性。

33

14.在类中对于没有实现的接口,应该

定义成抽象方法,类应该定义成抽象

类。(5级)

15.不要显式导入 https://www.doczj.com/doc/0318126121.html,ng.* 包;33

33

16.初始化时不要使用类的非静态属

性。

17.显式初始化所有的局部变量。33

33

18.按照方法名把方法排序放置,同名

合同类型的方法应该放在一起。

33

19.不要使用嵌套赋值,即在一个表达

式中使用多个 = 。

33

20.不要在抽象类的构建器中调用抽象

方法。

33

21.重载 equals() 方法的同时,也应

该重载 hashCode() 方法。

33

22.工具类(Utility)不要定义构建器,

包括私有构建器。

33

23.不要在 switch 中使用10个以上的

case 语句。

24.把 main() 方法放在类的最后。33

33

25.声明方法违例的时候不要使用

Exception ,应该使用它的子类。

33

26.不要直接扔出一个Error ,应该扔

出它的子类。

27.在进行比较的时候,总是把常量放

33

在同一边(都放在左边或者都放在右

边)。

33

28.在可能的情况下,总是为类定义一

个缺省的构建器。

VVVVVVV VVVVVVVVVVVX。XVX.X VX.X VX.X VX.XVX.X

29.在捕获违例的时候,不使用

33

Exception, RuntimeException,

Throwable,尽可能使用它们的子类。

33

30.在接口或者工具类中中定义常量。

(5级)

33

31.使用大写‘L’表示 long 常量。(5

级)

33

32.main() 方法必须是 public

static void main(String[])。(5级)

33.对返回类型为 boolean 的方法使

33

用 is 开头,其它类型的不能使用。

34.对非boolean类型取值方法

33

(getter)使用 get 开头,其它类型

的不能使用。

35.对于设置值的方法(setter)使用

33

set 开头,其它类型的不能使用。

34

36.方法需要有同样数量参数的注释

@param。

34

37.不要在注释中使用不支持的标记,

如:@unsupported 。

38.不要使用 Runtime.exec() 方法。34

34

39.不要自定义本地方法(native

method)。

40.使用尽量简洁的的运算符号。34

41.使用集合时设置初始容量。34

42.单个首字符的比较使用 charAt()

34

而不用 startsWith() 。

34

43.对于被除数或者被乘数为2的n次方

的乘除运算使用移位运算符 >>, << 。

34

44.一个字符的连接使用‘’而不使用

“”,如:String a = b + 'c'。

34

45.不要在循环体内调用同步方法和使

用 try-catch 块。

46.不要使用不必要的布尔值比较,如:

34

if (a.equals(b)), 而不是 if

(a.equals(b)==true)。

47.常量字符串使用 String, 非常量

34

字符串使用 StringBuffer 。

VVVVVVV VVVVVVVVVVVX。XVX.X VX.X VX.X VX.XVX.X

34

48.在循环条件判断的时候不要使用复

杂的表达式。

49.对于“if (condition) do1; else

34

do2;”语句使用条件操作符“if

(condition)?do1:do2;”。

50.不要在循环体内定义变量。34

51.使用StringBuffer的时候设置初始

34

容量。

52.尽可能的使用局部变量进行运算。34

34

53.尽可能少的使用‘!’操作符。(5

级)

34

54.尽可能的对接口进行 instanceof

运算。(5级)

34

55.不要使用 Date[] 而要使用

long[] 替代。

56.不要显式调用 finalize() 。34

34

57.不要使用静态集合,其内存占用增

长没有边界。

34

58.不要重复调用一个方法获取对象,

使用局部变量重用对象。

59.线程同步中,使用 notifyAll() 代

34

替 notify()。

34

60.避免在同步方法中调用另一个同步

方法造成的死锁。

34

61.非同步方法中不能调用 wait() ,

notify() 方法。

62.使用 wait(), notify() 代替

34

while(), sleep() 。

34

63.不要使用同步方法,使用同步块。

(5级)

64.把所有的公有方法定义为同步方

34

法。(5级)

34

65.实现的 Runnable.run() 方法必须

是同步方法。(5级)

66.一个只有abstract方法、final

34

static 属性的类应该定义成接口。

67.在 clone() 方法中应该而且必须

34

使用 super.clone() 而不是 new 。

VVVVVVV VVVVVVVVVVVX。XVX.X VX.X VX.X VX.XVX.X

68.常量必须定义为 final 。34

69.在 for 循环中提供终止条件。34

34

70.在 for, while 循环中使用增量计

数。

71.使用 StringTokenizer 代替

34

indexOf() 和 substring() 。

72.不要在构建器中使用非 final 方

34

法。

73.不要对参数进行赋值操作。(5级)35

74.不要通过名字比较两个对象的类,

35

应该使用 getClass() 。

75.安全:尽量不要使用内部类。35

76.安全:尽量不要使类可以克隆。35

77.安全:尽量不要使接口可以序列化。35

78.安全:尽量不要使用友好方法、属

35

性和类。

35

79.Servlet:不要使用

java.beans.Beans.instantiate() 方

法。

35

80.Servlet:不再使用HttpSession时,

应该尽早使用 invalidate() 方法释

放。

35

81.Servlet:不再使用JDBC资源时,应

该尽早使用 close() 方法释放。

82.Servlet:不要使用Servlet的

35

SingleThreadModel,会消耗大量资源。

35

83.国际化:不要使用一个字符进行逻

辑操作,使用 Characater。

84.国际化:不要进行字符串连接操作,

35

使用MessageFormat 。

85.国际化:不要使用

35

Date.toString() ,Time.toString()

方法。

35

86.国际化:字符和字符串常量应该放

在资源文件中。

VVVVVVV VVVVVVVVVVVX。XVX.X VX.X VX.X VX.XVX.X

87.国际化:不要使用数字的

35

toString() 方法。

35

88.国际化:不要使用 StringBuffer ,

StringTokenizer类。

89.国际化:不要使用 String 类的

35

compareTo(), equals() 方法。

90.复杂度:建议的最大规模:35 1 参考文献36

VVVVVVV VVVVVVVVVVVX。XVX.X VX.X VX.X VX.XVX.X

前言

本规范是参考公司的《软件编程规范总则》和SUN公司《Java Coding Style Guide》结合而成的Java语言编程规范。本规范没有涉及到的相关部分,请参见《软

件编程规范总则》。

本规范由OMC与网管研究管理部,智能业务研究管理部提出。

本规范主要起草和解释部门:OMC与网管研究管理部,智能业务研究管理部

本规范主要起草人:易雄志,张晋,李大伟,傅贵,童志刚,望岳

本规范主要审核人:

本规范批准人:

本规范规范所替代的历次修订情况和修订人为:

智能业务部对本规范的以下方面进行了补充和完善:1、排版规范,2、注释

规范,3、命名规范,4、编码规范,5、JTEST规范。并且按照最新模版进行重新排

版。

VVVVVVV VVVVVVVVVVVX。XVX.X VX.X VX.X VX.XVX.X

Java语言编程规范

1范围

本规范规定了使用Java语言编程时排版、注释、命名、编码和JTEST的规则和建议。

本规范适用于使用Java语言编程的部门和产品。

2规范性引用文件

下列文件中的条款通过本规范的引用而成为本规范的条款。凡是注日期的引用文件,其随

后所有的修改单(不包括勘误的内容)或修订版均不适用于本规范,然而,鼓励根据本规范达

成协议的各方研究是否可使用这些文件的最新版本。凡是不注日期的引用文件,其最新版本适

用于本规范。

序号编号名称

1 公司-0000 《软件编程规范总则》同总则

的部分使用*号

2 公司-DKBA200106-003《Java语言编程规范》

1术语和定义

规则:编程时强制必须遵守的原则。

建议:编程时必须加以考虑的原则。

格式:对此规范格式的说明。

说明:对此规范或建议进行必要的解释。

示例:对此规范或建议从正、反两个方面给出例子。

II.排版规范

A.规则

1. *程序块要采用缩进风格编写,缩进的空格数为4个。

说明:对于由开发工具自动生成的代码可以有不一致。

2. *分界符(如大括号‘{’和‘}’)应各独占一行并且位于同一列,同时与引用它们

的语句左对齐。在函数体的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。

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

for (...) {

... // program code

}

if (...)

{

... // program code

}

void example_fun( void )

{

... // program code

}

应如下书写。

for (...)

{

... // program code

}

if (...)

{

... // program code

}

void example_fun( void )

{

... // program code

}

3. *较长的语句、表达式或参数(>80字符)要分成多行书写,长表达式要在低优先级操

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

示例:

if (filename != null

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

{

... // program code

}

public static LogIterator read(String logType, Date startTime, Date endTime,

int logLevel, String userName, int bufferNum)

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

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

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();

应如下书写:

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. *在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或

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

华为JAVA编码规范

1.程序块采用缩进风格,空格为4个. 说明: 对于开发工具自动生成的代码可以不一致 2.分界符(如大括号{和})应各自占一行并且在同一列,同时与引用它们的 语句左对齐,在方法的开始,类和接口的定义,以及if,for,do,while,switch,case语句都要采用上述缩进 说明: for(…) { … 说明: if(filename != null && new File(logPath+filename).length() < ()) { 3.…作符) 说明: 采用这种松散方式编写代码目的是让程序更加清晰,由于空格所产生的清晰性是相对的,所以在已经很清晰的语句中没有必要留空格,如果语句已足够清晰,则括号内侧(即左括号后面和右括号前面)不需要加空格,多重括号间不必加空格,因为java中括号已经是很清晰的标志了. 在长句中,如果需要加的空格非常多,那么应该保持整体清晰,而在局部

中不加空格,给操作符留空格时不要连续留两个以上空格 4.类属性和方法不要交叉放置,不同存取范围的属性和方法也不要交叉放 置 说明: 类定义:{ 类公有属性定义; 类保护属性定义; 类私有属性定义; 类公有方法定义; 类保护方法定义; 类私有方法定义; } 5.源程序的有效注释量必须在30%以上 6.包的注释写入一个名为的html格式的说明文件放入当前路径 7.包的注释内容:本包作用,详细描述本包内容,产品模块名称及版本,公 司版本 说明: 一句话描述 详细描述

产品模块
公司版本信息 8.文件注释:写入文件头部,包名之前 9.文件注释内容:版本说明,描述信息,修改历史,生成日期 说明: /* *文件名 *版权 *描述 *修改人 *修改时间 *修改内容 *跟踪单号 *修改单号 */ 10.类和接口注释:放在package注释之后,class或interface之前 11.类和接口注释内容:类的注释要一句话功能描述,功能详细描述 说明:

华为JAVA编程规范

1 Java 编程规范 1.1 排版 1.1.1 规则 规则1程序块要采用缩进风格编写,缩进的空格数为4个,不允许使用TAB缩进。(1.42+) 说明:缩进使程序更易阅读,使用空格缩进可以适应不同操作系统与不同开发工具。 规则2分界符(如大括号…{?和…}?)应各独占一行,同时与引用它们的语句左对齐。在函数体的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程序 或者static、,synchronized等语句块中都要采用如上的缩进方式。(1.42+) 示例: if (a>b) { doStart(); } 规则3较长的语句、表达式或参数(>80字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐, 语句可读。(1.42+) 示例: if (logger.isDebugEnabled()) { logger.debug("Session destroyed,call-id" + event.getSession().getCallId()); } 规则4不允许把多个短语句写在一行中,即一行只写一条语句(1.42+) 说明:阅读代码更加清晰 示例:如下例子不符合规范。 Object o = new Object(); Object b = null; 规则5if, for, do, while, case, switch, default 等语句自占一行,且if, for, do, while,switch等语句的执行语句无论多少都要加括号{},case 的执行语句中如果定义变量必须加括号{}。 (1.42+) 说明:阅读代码更加清晰,减少错误产生 示例: if (a>b) { doStart(); }

华为Java语言编码规范标准

Java语言编码规范 Prepared by 拟制Date 日期 yyyy-mm-dd Reviewed by 评审人Date 日期 yyyy-mm-dd Approved by 批准Date 日期 yyyy-mm-dd

Revision Record 修订记录

Table of Contents 目录 1. 范围 (4) 2. 规范性引用文件 (4) 3. 术语和定义 (4) 4. 排版规范 (5) 4.1. 规则 (5) 4.2. 建议 (7) 5. 注释规范 (9) 5.1. 规则 (9) 5.2. 建议 (15) 6. 命名规范 (17) 6.1. 规则 (17) 6.2. 建议 (18) 7. 编码规范 (20) 7.1. 规则 (20) 7.2. 建议 (24) 8. JTEST规范 (26) 8.1. 规则 (26) 8.2. 建议 (27)

1.范围 本规范规定了使用Java语言编程时排版、注释、命名、编码和JTEST的规则和建议。 本规范适用于使用Java语言编程的产品和项目。 2.规范性引用文件 下列文件中的条款通过本规范的引用而成为本规范的条款。凡是注日期的引用文件,其随后所有的修改单(不包括勘误的内容)或修订版均不适用于本规范,然而,鼓励根据本规范达成协议的各方研究是否可使用这些文件的最新版本。凡是不注日期的引用文件,其最新版本适用于本规范。 3.术语和定义 规则:编程时强制必须遵守的原则。 建议:编程时必须加以考虑的原则。 格式:对此规范格式的说明。 说明:对此规范或建议进行必要的解释。 示例:对此规范或建议从正、反两个方面给出例子。

(完整版)阿里巴巴编码规范(Java)题库

多选 1.如何处理单元测试产生的数据,下列哪些说法是正确的?ABC A .测试数据入库时加特殊前缀标识。 B .测试数据使用独立的测试库。 C .自动回滚单元测试产生的脏数据。 D .无须区别,统一在业务代码中进行判断和识别。 多选 2.关于并发处理,下列哪些说法符合《阿里巴巴Java开发手册》:ABC A .线程资源必须通过线程池提供,不允许在应用中自行显式创建线程。 B .同步处理时,能锁部分代码区块的情况下不要锁整个方法;高并发时,同步调用应该考虑到性能损耗。 C .创建线程或线程池时,推荐给线程指定一个有意义的名称,方便出错时回溯。 D .推荐使用Executors.newFixedThreadPool(int x)生成指定大小的线程池。(线程池不允许使用 Executors 去创建,而是通过 ThreadPoolExecutor 的方式) 多选 3.下列哪些说法符合《阿里巴巴Java开发手册》:ACD A .对于“明确停止使用的代码和配置”,如方法、变量、类、配置文件、动态配置属性等要坚决从程序中清理出去,避免造成过多垃圾。 B .永久弃用的代码段注释掉即可,即不用加任何注释。 C .对于暂时被注释掉,后续可能恢复使用的代码片断,在注释代码上方,统一规定使用三个斜杠(///)来说明注释掉代码的理由。 D .不要在视图模板中加入任何复杂的逻辑。 多选 4.关于分页查询,下列哪些说法符合《阿里巴巴Java开发手册》:ABC A .分页查询,当统计的count为0时,应该直接返回,不要再执行分页查询语句。 B .iBATIS自带的queryForList(String statementName,int start,int size)分页接口有性能隐患,不允许使用。 C .定义明确的sql查询语句,通过传入参数start和size来实现分页逻辑。 D .可使用存储过程写分页逻辑,提高效率。

java编码规范(建议稿,修改自华为规范)(1)解析

武汉中软卓越科技有限公司Java语言编码规范

Table of Contents 目录 1. 范围 (3) 2. 术语和定义 (3) 3. 排版规范 (4) 3.1. 规则 (4) 3.2. 建议 (6) 4. 注释规范 (7) 4.1. 规则 (7) 4.2. 建议 (12) 5. 命名规范 (14) 5.1. 规则 (14) 5.2. 建议 (15) 6. 编码规范 (17) 6.1. 规则 (17) 6.2. 建议 (20) 7. JTEST规范 (22) 7.1. 规则 (22) 7.2. 建议 (23)

1.范围 本规范规定了使用Java语言编程时排版、注释、命名、编码和JTest的规则和建议。 本规范适用于使用Java语言编程的案例、产品和项目。 2.术语和定义 规则:编程时强制必须遵守的原则。 建议:编程时必须加以考虑的原则。 格式:对此规范格式的说明。 说明:对此规范或建议进行必要的解释。 示例:对此规范或建议从正、反两个方面给出例子。

3.排版规范 3.1.规则 3.1.1.*程序块要采用缩进风格编写,缩进的空格数为4个。 说明:对于由开发工具自动生成的代码可以有不一致。 3.1.2.*语句块分隔符左括号‘{’应与语句块引用代码在同一行,右括号‘}’应另起一行并 与语句块引用代码左对齐。在函数体的开始、类和接口的定义、以及if、for、do、 while、switch、case语句中的程序都要采用如上的缩进方式。 示例:如下例子不符合规范。 for (...) { ... // program code } if (...) { ... // program code } void example_fun( void ) { ... // program code } 应如下书写: for (...){ ... // program code } if (...){ ... // program code } void example_fun( void ){ ... // program code } 3.1.3.*较长的语句、表达式或参数(>80字符)要分成多行书写,长表达式要在低优先级操作 符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。 示例: if (filename != null && new File(logPath + filename).length() < LogConfig.getFileSize()){ ... // program code } public static LogIterator read(String logType, Date startTime, Date endTime, int logLevel, String userName, int bufferNum) 3.1.4.*不允许把多个短语句写在一行中,即一行只写一条语句

华为JAVA编程规范试题

JAVA编程规范试题 一、判断题(每题2分,共28分) 1、if, for, do, while, case, switch, default 等语句自占一行,且if, for, do, while, switch, case等语句的执行语句无论多少都要加括号{}。 2、包的注释内容要求包括:简述本包的作用、详细描述本包的内容、产品模块 名称和版本、公司版权、生成日期等。 3、类注释部分,描述部分说明该类或者接口的功能、作用、使用方法和注意事 项,每次修改后增加作者、新版本号和当天的日期,@since 表示从那个版本开始就有这个类或者接口,@deprecated 表示不建议使用该类或者接口。4、对于方法内部用throw语句抛出的异常,必须在方法的注释中标明;对于所 调用的其他方法所抛出的异常,在注释中要求说明所有的异常;对于非RuntimeException,即throws子句声明会抛出的异常,必须在方法的注释中标明。 5、类名和接口使用完整的英文单词描述,每个英文单词的首字母使用大写、其 余字母使用小写的大小写混合法。 6、com.huawei.四级部门名称.项目名称,符合包命名规范。 7、不能用异常来做一般流程处理的方式,不要过多地使用异常,异常的处理效 率比条件分支低,而且异常的跳转流程难以预测。 8、划分类的时候,应该尽量把逻辑处理、数据和显示分离,实现类功能的多样 化。 9、一个方法不应抛出太多类型的异常,如果程序中需要分类处理异常,则将异 常根据分类组织成继承关系。 10、switch 语句中的 case 关键字要和后面的常量保持一个空格;如果有特殊 的需要要在switch语句中定义case以外的标签,需要在注释中说明。 11、没有被覆盖的友好方法和没有子类的友好类应该定义成final。 12、简单的类可以通过名字比较两个对象的类,推荐使用 getClass()或者 instanceof()。 13、不要调用 Thread 类的 resume(), suspend(),sleep(), stop() 方法。

Java语言编程规范华为

精心整理DKBA 华为技术有限公司企业技术规范 DKBA1040-2001.12 代替(DKBA200106-003)

目次 前言 (3) 1范围11 2规范性引用文件11 3术语和定义11 4排版规范12 12 5 2.包的注释:包的注释写入一个名为package.html的HTML格式的说明文 件放入当前路径。 16 3.包的注释内容:简述本包的作用、详细描述本包的内容、产 品模块名称和版本、公司版权。 16 4.文件注释:文件注释写入文件头部,包名之前的位置。16 5.文件注释内容:版权说明、描述信息、生成日期、修改历史。17 6.类和接口的注释:该注释放在package关键字之后,class或者interface关键字之前。18

18 7.类和接口的注释内容:类的注释主要是一句话功能简述、功能详 细描述, 8.类属性、公有和保护方法注释:写在类属性、公有和保护方法上面。19 19 9.成员变量注释内容:成员变量的意义、目的、功能,可能被用到的地 方。 19 10.公有和保护方法注释内容:列出方法的一句话功能简述、功能详 细描述、输入参数、输出参数、返回值、违例等。 20 11.对于方法内部用throw语句抛出的异常,必须在方法的注释中 标明,对于所调用的其他方法所抛出的异常,选择主要的在注 释中说明。对于非RuntimeException,即throws子句声明会抛出Array 7.注释尽量使用中文注释和中文标点。方法和类描述的第一句话尽量使 23 用简洁明了的话概括一下功能,然后加以句号。接下来的部分可以详细 描述。 23 8.顺序实现流程的说明使用1、2、3、4在每个实现步骤部分的代 码前面进行注释。 9.一些复杂的代码需要说明。23 6命名规范24 6.1规则24

华为JAVA编程要求规范重要试题

JAVA编程规试题 一、判断题(每题2分,共28分) 1、if, for, do, while, case, switch, default 等语句自占一行,且if, for, do, while, switch, case等语句的执行语句无论多少都要加括号{}。 2、包的注释容要求包括:简述本包的作用、详细描述本包的容、产品模块名称 和版本、公司、生成日期等。 3、类注释部分,描述部分说明该类或者接口的功能、作用、使用方法和注意事 项,每次修改后增加作者、新版本号和当天的日期,since 表示从那个版本开始就有这个类或者接口,deprecated 表示不建议使用该类或者接口。 4、对于方法部用throw语句抛出的异常,必须在方法的注释中标明;对于所调 用的其他方法所抛出的异常,在注释中要求说明所有的异常;对于非RuntimeException,即throws子句声明会抛出的异常,必须在方法的注释中标明。 5、类名和接口使用完整的英文单词描述,每个英文单词的首字母使用大写、其 余字母使用小写的大小写混合法。 6、.huawei.四级部门名称.项目名称,符合包命名规。 7、不能用异常来做一般流程处理的方式,不要过多地使用异常,异常的处理效 率比条件分支低,而且异常的跳转流程难以预测。 8、划分类的时候,应该尽量把逻辑处理、数据和显示分离,实现类功能的多样 化。 9、一个方法不应抛出太多类型的异常,如果程序中需要分类处理异常,则将异 常根据分类组织成继承关系。 10、switch 语句中的 case 关键字要和后面的常量保持一个空格;如果有特殊 的需要要在switch语句中定义case以外的标签,需要在注释中说明。 11、没有被覆盖的友好方法和没有子类的友好类应该定义成final。 12、简单的类可以通过名字比较两个对象的类,推荐使用 getClass()或者 instanceof()。 13、不要调用 Thread 类的 resume(), suspend(),sleep(), stop() 方法。 14、判断方法是否是重载,只关注方法名、参数个数、参数类型,不关注方法返

Java语音编码规范华为

Java语音编码规范(华为) Java语言编码规范 Prepared by 拟制Date 日期 yyyy-mm-dd Reviewed by 评审人Date 日期 yyyy-mm-dd Approved by Date yyyy-mm-dd

Revisi on Record 修订记录

1.范围................................... 2.规范性引用文件............................... 3.术语和定义................................ 4.排版规范.................................. 4.1. 规则................................... 4.2. 建议..... 5. 注释规范 5.1. 规 则........ 5.2. 建议..... 6. 命名规范 6.1. 规 则........ 6.2. 建议..... 7. 编码规范 7.1. 规 则........ 7.2. 建议..... 8. JTEST规 范8.1. 规 则........ 8.2. 建议 ....................................

1.范围 本规范规定了使用Java语言编程时排版、注释、命名、编码和JTEST的规则和建议。 本规范适用于使用Java语言编程的产品和项目。 2.规范性引用文件 下列文件中的条款通过本规范的引用而成为本规范的条款。凡是注日期的引用文 件,其随后所有的修改单(不包括勘误的内容)或修订版均不适用于本规范,然而,鼓励根据本规范达成协议的各方研究是否可使用这些文件的最新版本。凡是不注日期的引用文件,其最新版本适用于本规范。 3.术语和定义 规则:编程时强制必须遵守的原则。 建议:编程时必须加以考虑的原则。 格式:对此规范格式的说明。 说明:对此规范或建议进行必要的解释示例:对此规范或建议从正、反两个方面给出例子。

JAVA最全的编码规范

JAVA最全的编码规范 (1) 类名首字母应该大写。字段、方法以及对象(句柄)的首字母应小写。对于所有标识符,其中包含的所有单词都应紧靠在一起,而且大写中间单词的首字母。例如: ThisIsAClassName thisIsMethodOrFieldName 若在定义中出现了常数初始化字符,则大写static final基本类型标识符中的所有字母。这样便可标志出它们属于编译期的常数。 Java包(Package)属于一种特殊情况:它们全都是小写字母,即便中间的单词亦是如此。对于域名扩展名称,如com,org,net或者edu 等,全部都应小写(这也是Java 1.1和Java 1.2的区别之一)。 (2) 为了常规用途而创建一个类时,请采取"经典形式",并包含对下述元素的定义: equals() hashCode() toString() clone()(implement Cloneable) implement Serializable (3) 对于自己创建的每一个类,都考虑置入一个main(),其中包含了用于测试那个类的代码。为使用一个项目中的类,我们没必要删除测试代码。若进行了任何形式的改动,可方便地返回测试。这些代码也可作为如何使用类的一个示例使用。 (4) 应将方法设计成简要的、功能性单元,用它描述和实现一个不连续的类接口部分。理想情况下,方法应简明扼要。若长度很大,可考虑通过某种方式将其分割成较短的几个方法。这样做也便于类内代码的重复使用(有些时候,方法必须非常大,但它们仍应只做同样的一件事情)。 (5) 设计一个类时,请设身处地为客户程序员考虑一下(类的使用方法应该是非常明确的)。然后,再设身处地为管理代码的人考虑一下(预计有可能进行哪些形式的修改,想想用什么方法可把它们变得更简单)。 (6) 使类尽可能短小精悍,而且只解决一个特定的问题。下面是对类设计的一些建议: 一个复杂的开关语句:考虑采用"多形"机制

Java语音编码规范 华为

Java语音编码规范(华为) 【最新资料,WORD文档,可编辑修改】

Java语言编码规范 Prepared by 拟制Date 日期 yyyy-mm-dd Reviewed by 评审人Date 日期 yyyy-mm-dd Approved by 批准Date 日期 yyyy-mm-dd

Revision Record 修订记录

Table of Contents 目录

1.范围 本规范规定了使用Java语言编程时排版、注释、命名、编码和JTEST的规则和建议。 本规范适用于使用Java语言编程的产品和项目。 2.规范性引用文件 下列文件中的条款通过本规范的引用而成为本规范的条款。凡是注日期的引用文件,其随后所有的修改单(不包括勘误的内容)或修订版均不适用于本规范,然而,鼓励根据本规范达成协议的各方研究是否可使用这些文件的最新版本。凡是不注日期的引用文件,其最新版本适用于本规范。 3.术语和定义 规则:编程时强制必须遵守的原则。 建议:编程时必须加以考虑的原则。 格式:对此规范格式的说明。 说明:对此规范或建议进行必要的解释。 示例:对此规范或建议从正、反两个方面给出例子。

4.排版规范 4.1.规则 4.1.1.*程序块要采用缩进风格编写,缩进的空格数为4个。 说明:对于由开发工具自动生成的代码可以有不一致。 4.1.2.*分界符(如大括号‘{’和‘}’)应各独占一行并且位于同一列, 同时与引用它们的语句左对齐。在函数体的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。 示例:如下例子不符合规范。 for (...) { ... .) { ... . .) { ... .) { ... . ength() < ()) { 4.1.3.... ,后不应加空格。 说明:采用这种松散方式编写代码的目的是使代码更加清晰。 由于留空格所产生的清晰性是相对的,所以,在已经非常清晰的语句中没有必要再留空格,如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格,多重括号间不必加空格,因为在Java语言中括号已经是最清晰的标志了。 在长语句中,如果需要加的空格非常多,那么应该保持整体清晰,而在局部不加空格。给操作符留空格时不要连续留两个以上空格。 示例: (1)逗号、分号只在后面加空格。 int a, b, c; (2)比较操作符, 赋值操作符"="、"+=",算术操作符"+"、"%",逻辑操作符"&&"、"&",位域

[实用参考]Java编码规范.doc

Java语言编码规范 青岛一图环视信息技术有限公司 Preparedby 拟制魏志宇 Date 日期 2017-09-11 Reviewedby 评审人Date 日期 Approvedby 批准Date 日期

RevisionRecord修订记录

TableofContents目录 1. 范围 (4) 2. 规范性引用文件 (4) 3. 术语和定义 (4) 4. 排版规范 (5) 4.1. 规则 (5) 4.2. 建议 (7) 5. 注释规范 (8) 5.1. 规则 (8) 5.2. 建议 (13) 6. 命名规范 (16) 6.1. 规则 (16) 6.2. 建议 (17) 7. 编码规范 (19) 7.1. 规则 (19) 7.2. 建议 (23) 8. JTEST规范 (25) 8.1. 规则 (25) 8.2. 建议 (26)

1.范围 本规范规定了使用Java语言编程时排版、注释、命名、编码和JTEST的规则和建议。 本规范适用于使用Java语言编程的产品和项目。 2.规范性引用文件 下列文件中的条款通过本规范的引用而成为本规范的条款。凡是注日期的引用文件,其随后所有的修改单(不包括勘误的内容)或修订版均不适用于本规范,然而,鼓励根据本规范达成协议的各方研究是否可使用这些文件的最新版本。凡是不注日期的引用文件,其最新版本适用于本 3.术语和定义 规则:编程时强制必须遵守的原则。 建议:编程时必须加以考虑的原则。 格式:对此规范格式的说明。 说明:对此规范或建议进行必要的解释。 示例:对此规范或建议从正、反两个方面给出例子。

华为代码规范文档

代码规范文档

目录 1概述 (3) 1.1编写目的 (3) 1.2文档约定 (3) 1.3预期的读者和阅读建议 (3) 1.4参考文献 (3) 2排版要求 (4) 2.1程序块缩进 (4) 2.2程序块之间空行 (4) 2.3长语句和长表达式 (4) 2.4循环、判断等长表达式或语句 (5) 2.5短语句 (6) 2.6条件、循环语句 (6) 2.7语句对齐 (6) 2.8函数、过程和结构等语句块 (7) 2.9程序块分界符 (7) 2.10说明性文件 (8) 2.11源文件头 (8) 2.12变量、常量注释 (9) 2.13数据结构的注释 (9) 2.14全局变量 (10) 2.15其他 (10) 2.16命名规范与系统风格一致 (12) 2.17其他 (12) 3可读性 (14) 3.1运算符优先级 (14) 3.2避免直接使用数字作为标识符 (14) 4函数、过程 (16) 4.1对所调用函数的错误返回码要仔细、全面地处理。 (16) 4.2明确函数功能,精确(而不是近似)地实现函数设计。 (16) 4.3局部变量 (16) 4.4全局变量 (16) 5可测性 (17) 5.1调测开关 (17) 5.2打印信息 (17) 5.3单元测试 (17) 5.4集成测试 (17) 5.5断言使用 (18) 5.6使用宏时,不允许参数发生变化 (20)

1概述 1.1编写目的 为规范软件开发人员的代码编写提供参考依据和统一标准。 1.2文档约定 说明本文档中所用到的专用术语定义或解释,缩略词定义。 1.3预期的读者和阅读建议 本文档适用于所有软件开发人员。 1.4参考文献 列出有关的参考文件,如: a.属于本项目的其他已发表文件; b.本文件中各处引用的文档资料。 列出这些文件的标题、作者,说明能够得到这些文件资料的来源。

java编码规范考试题答案

一、单选题 1. 如下关于集合类的描述错误的是B A. 含有集合意义的属性命名,尽量包含其复数的意义 B. 集合中的数据不需要释放,垃圾回收器会自动回收 C. 集合必须指定模板类型 D. 使用集合类时要设置初始化容量 2. 关于线程以下说法错误的有B A. 新起一个线程,都要使用Thread.setName(“…”)设置线程名 B. 在JDK1.5或更新的版本中,若字符串拼接发生在单线程环境,使用StringBuffer C. 对多线程访问的变量、方法,必须加锁保护,避免出现多线程并发访问引起的问题 D. 线程使用时,要在代码框架中使用线程池,避免创建不可复用的线程;禁止在循环中创建新线程,否则会引起JVM资源耗尽 3. 下面哪个是推荐使用的对称密码算法B A. DES B. AES C. SHA D. RSA

4. 以下说法正确的有C A. 程序中的一些状态多直接用数字表示,如函数执行成功return 1 B. 对于表示函数执行错误,多用约定的错误码来标识 C. 用有意义的静态变量或者枚举来代替数字型的程序状态,如函数执行成功return SUCCESS D. 程序中的魔鬼数字并不可怕,需要所有开发人员努力理解这些数字的含义 5. 下列错误使用异常的做法是D A. 在程序中使用异常处理还是使用错误返回码处理,根据是否有利于程序结构来确定,并且异常和错误码不应该混合使用,推荐使用异常 B. 一个方法不应抛出太多类型的异常。throws/exception子句标明的异常最好不要超过三个 C. 异常捕获尽量不要直接catch (Exception ex),应该把异常细分处理 D. 程序内抛出的异常本身就可说明异常的类型、抛出条件,可不填写详细的描述信息。捕获异常后用exception.toString()取到详细信息后保存 6. 关于命名规范,以下说法错误的有D A. 属性名使用意义完整的英文描述,第一个单词的字母使用小写,剩余单词首字母大写其余字母小写的大小写混合法。属性名不能与方法名相同 B. 方法名使用类意义完整的英文描述:第一个单词的字母使用小写、剩余单词首字母大写其余字母小写的大小写混合法 C. 方法中,存取属性的方法采用setter 和getter方法,动作方法采用动词和动宾结构

Java语言编程规范华为年

DKBA 华为技术有限公司企业技术规范 DKBA1040-2001.12 代替(DKBA200106-003)Java语言编程规范 2001-12-XX发布2001-12-XX实施 华为技术有限公司发布

目次 前言 (3) 1 范围11 2 规范性引用文件11 3 术语和定义11 4 排版规范12 4.1 规则12 1.*程序块要采用缩进风格编写,缩进的空格数为4个。12 12 2.*分界符(如大括号‘{’和‘}’)应各独占一行并且位于同 一列,同时与引用它们的语句左对齐。在函数体的开始、类和 接口的定义、以及if、for、do、while、switch、case语句中的程 序都要采用如上的缩进方式。 13 3.*较长的语句、表达式或参数(>80字符)要分成多行书写, 长表达式要在低优先级操作符处划分新行,操作符放在新行之 首,划分出的新行要进行适当的缩进,使排版整齐,语句可 读。

4.*不允许把多个短语句写在一行中,即一行只写一条语句13 5.*if, for, do, while, case, switch, default 等语句自占一行,且if, for, 13 do, while等语句的执行语句无论多少都要加括号{}。 6.*相对独立的程序块之间、变量说明之后必须加空行。13 7.*对齐只使用空格键,不使用TAB键。14 14 8.*在两个以上的关键字、变量、常量进行对等操作时,它们之 间的操作符之前、之后或者前后要加空格;进行非对等操作 时,如果是关系密切的立即操作符(如.),后不应加空格。 4.2 建议15 15 1.类属性和类方法不要交叉放置,不同存取范围的属性或者方 法也尽量不要交叉放置。 5 注释规范16 5.1 规则16 1.一般情况下,源程序有效注释量必须在30%以上。16 16 2.包的注释:包的注释写入一个名为 package.html 的HTML格式 的说明文件放入当前路径。

华为JAVA编码规范

1.程序块采用缩进风格,空格为4个、 说明: 对于开发工具自动生成的代码可以不一致 2.分界符(如大括号{与})应各自占一行并且在同一列,同时与引用它们的语句左 对齐,在方法的开始,类与接口的定义,以及if,for,do,while,switch,case语句都要采用上述缩进 说明: for(…) { …//your code } 3.较长(>80字符)的语句,表达式与参数要分多行,长表达式要在低优先级操作符 划分新行,操作符放在行首,新行要适当缩进,整齐,语句可读、 说明: if( != null && new )、length() < logConfig、get()) { …//your code } 4.一行只写一条语句 说明: Log wow = null; Log that = null; 5.if,for,do,switch,while,case,default各占一行,它们的执行语句无论多少都要加{} 说明: if(writeToFile) { write(); } 6.相对独立的程序块,变量,说明要加空行 说明: if(log、getLevel() < log、getRecord()) { return ; } //空行

LogWrite writer; 7.对齐只用空格键,不用TAB键 说明: 以免使用不同的编辑器阅读程序时,因TAB键所设置的空格数不同而造成程序布局不整齐,JBuildr,UltraEdit等编辑环境,支持行首TAB替换成空格,应将该选项打开 8.两个以上的关键字,变量,常量进行对等操作时,操作符之前,之后或前后要加空 格,进行非对等操作时,如果就是关系密切的立即操作符,后面不加空格(如、操作符) 说明: 采用这种松散方式编写代码目的就是让程序更加清晰,由于空格所产生的清晰性就是相对的,所以在已经很清晰的语句中没有必要留空格,如果语句已足够清晰,则括号内侧(即左括号后面与右括号前面)不需要加空格,多重括号间不必加空格,因为java中括号已经就是很清晰的标志了、在长句中,如果需要加的空格非常多,那么应该保持整体清晰,而在局部中不加空格,给操作符留空格时不要连续留两个以上空格 9.类属性与方法不要交叉放置,不同存取范围的属性与方法也不要交叉放置 说明: 类定义:{ 类公有属性定义; 类保护属性定义; 类私有属性定义; 类公有方法定义; 类保护方法定义; 类私有方法定义; } 10.源程序的有效注释量必须在30%以上 11.包的注释写入一个名为package、html的html格式的说明文件放入当前路径 12.包的注释内容:本包作用,详细描述本包内容,产品模块名称及版本,公司版本 说明: 一句话描述 详细描述 产品模块
公司版本信息

Java语言编码规范

Java语言编码规范(Java Code Conventions)

目录 1 介绍(Introduction) (4) 2 文件组织(File Organization) (4) 2.1 Java源文件(Java Source Files) (4) 2.1.1 开头注释(Beginning Comments) (4) 2.1.2 包和引入语句(Package and Import Statements) (5) 2.1.3 类和接口声明(Class and Interface Declarations) (5) 3 缩进排版(Indentation) (6) 3.1 行长度(Line Length) (6) 3.2 换行(Wrapping Lines) (6) 4 注释(Comments) (8) 4.1 实现注释的格式(Implementation Comment Formats) (9) 4.1.1 块注释(Block Comments) (9) 4.1.2 单行注释(Single-Line Comments) (9) 4.1.3 尾端注释(Trailing Comments) (9) 4.1.4 行末注释(End-Of-Line Comments) (10) 4.2 文档注释(Documentation Comments) (10) 5 声明(Declarations) (11) 5.1 每行声明变量的数量(Number Per Line) (11) 5.2 初始化(Initialization) (12) 5.3 布局(Placement) (12) 5.4 类和接口的声明(Class and Interface Declarations) (13) 6 语句(Statements) (14) 6.1 简单语句(Simple Statements) (14) 6.2 复合语句(Compound Statements) (14) 6.3 返回语句(return Statements) (14) 6.4 if-else语句(if-else Statements) (15) 6.5 for语句(for Statements) (15) 6.6 while语句(while Statements) (16) 6.7 do-while语句(do-while Statements) (16) 6.8 switch语句(switch Statements) (16)

相关主题
相关文档 最新文档