Java 代码编程格式规范
目 录
1 前言.................................................................................................................................................5
2 适用范围.........................................................................................................................................5
3 命名规范.........................................................................................................................................5
3.1 PACKAGE 的命名.....................................................................................................................5
3.2 CLASS 的命名..........................................................................................................................5
3.3 CLASS 成员的命名..................................................................................................................6
3.4 STATIC FINAL 变量的命名.......................................................................................................6
3.5 前后台变量名称....................................................................................................................6
3.6 参数的命名............................................................................................................................6
3.7 数组的命名............................................................................................................................6
3.8 方法的参数............................................................................................................................6
3.9 缩写........................................................................................................................................7
3.10 标识符命名中应注意的问题..............................................................................................7
3.10.1 除局部循环变量外变量名禁止取单个字符 7
3.10.2 不用数字定义名字 7
3.10.3 用正确的反义词组命名 8
3.10.4 避免使用 8
4 样式.................................................................................................................................................9
4.1 JAVA 文件样式.........................................................................................................................9
4.1.1 版权信息 9
4.1.2 Package/Imports 9
4.2 CLASS 的样式.........................................................................................................................10
4.2.1 Class 的定义 10
4.2.2 Class Fields 10
4.2.3 构造函数 10
4.2.4 克隆方法 11
4.2.5 类成员变量和方法的编写顺序 11
4.2.6 main 方法 12
4.3 代码样式..............................................................................................................................12
5 注释...............................................................................................................................................12
5.1 一般情况下..........................................................................................................................12
5.2 常规注释标记说明..............................................................................................................12
5.2.1 @since 13
5.2.2 @deprecated 13
5.2.3 @see 13
5.2.4 @link 14
5.3 类和接口注释说明..............................................................................................................14
5.4 方法注释说明......................................................................................................................15
6 书写格式规范...............................................................................................................................15
第 2 页，共 37 页
