一、命名规约
1、通过命名体现元素的特征:
- 类名采用大驼峰,即首字母大写,方法名采用小驼峰,即首字母小写。常量的命名单词全部大写,单词之间用下划线连接。
- 包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式,但是类名如果有复数含义,则可以使用复数形式。
- 抽象类命名使用Abstract或Base开头;异常类命名使用Exception结尾;测试类命名以它要测试的类名开始,以Test结尾。
- 类型与中括号紧挨相连来定义数组。
- 枚举类名带上Enum后缀,枚举成员名称需要全大写,单词间用下画线隔开。
2、代码展示风格
缩进:TAB与空格的使用:1TAB=4空格
空格的使用约定:
-
任何二目、三目运算符的左右两边都必须加一个空格
-
注释的双斜线与注释内容之间有且仅有一个空格。
-
方法参数在定义和传入时,多个参数逗号后边必须加空格。
-
没有必要增加若干空格使变量的赋值等号与上一行对应位置的等号对齐。
-
如果是大括号内为空,则简洁地写成{}即可,大括号中间无须换行和空格。
-
左右小括号与括号内部的相邻字符之间不要出现空袼。
-
左大括号前需要加空格。
-
空行:空行用来分割功能相似,逻辑内聚,意思相近的代码片段,使程序布局更加清晰。
换行:一般约定单行字符数不超过120个字符数,超出时则需要换行,换行时应遵循以下原则:
(1) 第二行相对第一行缩进4个空格,从第三行开始,不再继续缩进,如下图。
(2) 运算符与下文一起换行。
(3) 方法调用的点符号与下文一起换行。
(4) 方法调用中的多个参数需要换行时,在逗号后换行。
(5) 在括号前不要换行。
方法内行数的限制:一般单个方法内的行数不超过80行。
使用控制语句时的相关注意方法: -
在if、else、for、while、do-while等语句中必须使用大括号,即使只有一行代码,也需要加上大括号。
-
在条件表达式中不许有赋值操作,也不允许在判断表达式中出现复杂的逻辑组合。
-
多层嵌套不能超过3层。
-
避免采用取反逻辑运算符。
三、注释
注释的两种格式:
1、JavaDoc,类、类属性和类方法的注释必须遵循Javadoc规范,使用文档注释
(/* * */)的格式。 按Javadoc规范编写的注释,可以生成规范的JavaAPI文档。
**2、简单注释:**简单注释分为单行注释和多行注释,需要强调的是注释必须位于代码上方,不能写在代码后方。