没有合适的资源?快使用搜索试试~ 我知道了~
资源推荐
资源详情
资源评论
Java 代码编程格式规范
Java 代码编程格式规范
第 2 页,共 33 页
目 录
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 方法的参数...................................................6
3.10 缩写 .......................................................7
3.11 标识符命名中应注意的问题.....................................7
3.11.1 变量名禁止取单个字符 .....................................7
3.11.2 不用数字定义名字 .........................................7
3.11.3 避免标识符名字冲突 .......................................8
3.11.4 用正确的反义词组命名 .....................................8
3.11.5 避免使用 .................................................8
4 注释............................................................9
4.1 一般情况下...................................................9
4.2 常规注释标记说明.............................................9
4.2.1 @since ...................................................9
4.2.2 @deprecated ..............................................9
4.2.3 @see .....................................................9
4.2.4 @link ...................................................10
4.3 类和接口注释说明............................................10
4.4 方法注释说明................................................10
5 书写格式规范 ...................................................11
5.1 样式........................................................11
5.1.1 Java 文件样式 ...........................................11
5.1.2 Class 的样式.............................................12
5.1.3 代码样式 ................................................15
5.2 代码编写规范................................................15
5.2.1 缩进 ....................................................15
5.2.2 页宽 ....................................................16
5.2.3 空行 ....................................................16
5.2.4 空格的使用 ..............................................17
5.2.5 {}的用法 ................................................17
Java 代码编程格式规范
第 3 页,共 33 页
5.2.6 循环、判断等语句 ........................................18
5.2.7 参数划分 ................................................18
5.2.8 一行只写一条语句 ........................................19
5.2.9 程序块的分界符 ..........................................19
5.3 变量编写规范................................................20
5.3.1 公共变量 ................................................20
5.3.2 局部变量 ................................................21
5.4 程序编写规范................................................21
5.4.1 exit() ..................................................21
5.4.2 异常 ....................................................21
5.4.3 垃圾收集 ................................................22
5.4.4 final 类 ................................................22
5.4.5 访问类的成员变量 ........................................22
6 编程技巧.......................................................22
6.1 一般性原则..................................................22
6.1.1 检查所有参数输入的有效性。 ..............................23
6.1.2 检查参数输入 ............................................23
6.1.3 类名应准确描述类的功能。 ................................23
6.1.4 避免强制返回值类型 ......................................23
6.1.5 让调用点显得易懂、容易理解。 ............................23
6.1.6 减少数据类型转换 ........................................23
6.1.7 防止程序中的垃圾代码。 ..................................23
6.1.8 减少递归调用。 ..........................................23
6.1.9 使用数据流图 ............................................24
6.1.10 避免使用 BOOL 参数。 .....................................24
6.2 开发过程中的技巧............................................24
6.2.1 byte 数组转换到 characters ..............................24
6.2.2 Utility 类 ..............................................24
6.2.3 初始化数组 ..............................................24
6.2.4 枚举类型 ................................................25
6.2.5 Swing ...................................................25
6.2.6 Z-Order 问题 ............................................26
6.2.7 不必要的对象构造 ........................................26
6.2.8 synchronized 关键字 .....................................26
6.3 程序效率....................................................26
6.3.1 注意代码的效率 ..........................................26
6.3.2 提高代码效率 ............................................26
6.3.3 局部效率应为全局效率服务 ................................27
6.3.4 循环体内工作量最小化。 ..................................27
6.3.5 仔细分析有关算法,并进行优化。 ..........................27
6.3.6 改进输入方式 ............................................27
6.3.7 提高调用不频繁的代码效率要慎重 ..........................28
6.3.8 提高空间效率 ............................................28
Java 代码编程格式规范
第 4 页,共 33 页
6.3.9 循环的位置 ..............................................28
6.3.10 尽量减少循环嵌套层次。 ..................................29
6.3.11 避免循环体内含判断语句 ..................................29
6.3.12 不要一味追求紧凑的代码。 ................................30
7 性能...........................................................30
7.1 可移植性....................................................30
7.1.1 换行 ....................................................31
7.1.2 PrintStream .............................................31
7.2 可测性......................................................31
7.2.1 调测 ....................................................31
7.2.2 调测信息串格式 ..........................................31
7.2.3 在编程中注意单元测试 ....................................32
7.2.4 测试准备 ................................................32
7.2.5 测试手段 ................................................32
7.2.6 调测开关 ................................................32
7.2.7 调试与测试 ..............................................32
7.2.8 调测开关的级别和类型 ....................................33
7.2.9 编写防错程序 ............................................33
8 质量保证.......................................................33
8.1 代码质量保证优先原则........................................33
8.2 打开的文件要关闭............................................33
8.3 一致性检查..................................................34
8.4 SWITCH 语句必须有 DEFAULT 分支。 ................................34
8.5 其他质量问题................................................34
9 代码编辑、编译、审查 ...........................................34
9.1 统一编译环境................................................34
9.2 代码走读及评审..............................................34
9.3 QA 代码抽查 .................................................35
9.4 软件系统目录................................................35
Java 代码编程格式规范
第 5 页,共 33 页
1 前言
为确保系统源程序可读性,从而增强系统可维护性,java编程人员应具有基
本类似的编程风格,兹制定下述Java编程规范,以规范系统Java部分编程。系统
继承的其它资源中的源程序也应按此规范作相应修改。
2 适用范围
本文档将作为java编程人员软件开发的编程格式规范。在项目Java部分的编
码、测试及维护过程中,要求严格遵守。
3 命名规范
定义这个规范的目的是让项目中所有的文档都看起来像一个人写的,增加可
读性,减少项目组中因为换人而带来的损失。
3.1 Package 的命名
Package 的名字应该都是由一个小写单词组成。示例:unipost.trans
3.2 Class 的命名
Class 的名字每个单词必须由大写字母开头而其他字母都小写的单词组成。
示例:FileMng
3.3 Class 成员的命名
变量、方法、属性:大小写混排的单词组成,首字母小写
示例: functionName、countNum、size
剩余32页未读,继续阅读
资源评论
小小哭包
- 粉丝: 1900
- 资源: 3864
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功