百度规范
目 录
百度 Java 编码规范...........................................................................................................................1
1 前言................................................................................................................................................1
2 代码书写........................................................................................................................................1
2.1 程序块要采用 K&R 代码风格编写，缩进的空格数为 4 个, 不能使用 Tab 缩进【规
则】.............................................................................................................................................1
2.2 一行程序以小于 120 字符为宜，超长的语句应该在一个操作符之前折行，并在下
一行加入适当的空格进行缩进；当一个表达式无法容纳在一行内时，可以依据如下一
般规则断开之：【规则】.........................................................................................................1
2.3 if、while、for、do 语句的执行体总是用"{"和"}"括起来，即使单条语句也是【规
则】。并且在较长（超过一屏）的判断或者循环语句的结尾应该有注释语句做出标识。
【建议】.....................................................................................................................................2
2.4 每行仅包含一条语句。【规则】.....................................................................................2
3 命名要求........................................................................................................................................2
3.1 Package 的名字应该都是由一个小写单词组成。【规则】..........................................2
3.2 类(class)命名规则：类名是个一名词，大写开始，采用骆峰命名规则。使用完整
单词，避免缩写词(除非该缩写词被更广泛使用，像 URL，HTML)。【规则】 ...........3
3.3 参数和变量的名字必须用一个小写字母开头，后面的单词用大写字母开头, 只允许
使用字母和数字， 使用骆峰命名方式【规则】...................................................................3
3.4 常量和枚举的属性必须全部使用大写，并且使用完整含义的单词,每个单词之间使
用“_”分割 【规则】...................................................................................................................3
4 注释................................................................................................................................................3
4.1 要求类、接口、公有方法都必须添加注释【规则】....................................................3
4.2 方法注释采用标准的 javadoc 注释规范，注释中必须提供方法说明，参数说明和返
回值和异常说明。【规则】.....................................................................................................4
5 常量与变量....................................................................................................................................5
5.1 具有全局性逻辑功能的常量值需要定义为常量类型且相同含义的常量只能定义在
一处。【规则】.........................................................................................................................5
5.2 一行一个声明，避免在一个语句中给多个变量赋值。【规则】................................5
5.3 只在代码块的开始处声明变量，内外层的代码声明不要重名。【规则】................5
5.4 对于固定且编译时可列的对象，如 Status,Type 等，应采用 enum 而非自定义常量
实现。enum 的好处是类型更清楚，不会在编译时混淆【建议】......................................5
5.5 数组定义方法如下： 数组元素类型紧跟着”[]”,其后是数组标识。【规则】............6
6 空格................................................................................................................................................6
6.1 一个紧跟着括号的关键字应该用空格分开【规则】....................................................6
6.2 空格应该位于参数列表中逗号的后面【规则】............................................................6
6.3 所有的二元运算符，除了"."，都必须用空格与操作数分开【规则】........................6
6.4 for 语句中的表达式应该被空格分开【规则】...............................................................7
6.5 强制转型后应该跟一个空格【规则】............................................................................7
7 方法................................................................................................................................................7
7.1 方法行数不能超过 500 行, 类的行数不能超过 3000【规则】......................................7
7.2 方法的参数个数不能超过 7 个【规则】.........................................................................7
百度规范 - 1 -
评论3
最新资源