文档介绍：Java代码编程格式标准
目 录
1 前言 5
2 适用范围 5
3 命名标准 5
Package 的命名 5
Class 的命名 5
Class 变量的命名 6
Static Final 变量的命名 6
常量 6
前后台变量名称 6
参数的命名 6
数组的命名 6
方法的参数 6
缩写 7
标识符命名中应注意的问题 7
变量名禁止取单个字符 7
不用数字定义名字 7
防止标识符名字冲突 8
用正确的反义词组命名 8
防止使用 8
4 注释 9
一般情况下 9
常规注释标记说明 9
***@since 9
***@deprecated 9
***@see 9
***@link 10
类和接口注释说明 10
方法注释说明 10
5 书写格式标准 11
样式 11
Java 文件样式 11
Class的样式 12
代码样式 15
代码编写标准 15
缩进 15
页宽 16
空行 16
空格的使用 17
{}的用法 17
循环、判断等语句 18
参数划分 18
一行只写一条语句 19
程序块的分界符 19
变量编写标准 20
公共变量 20
局部变量 21
程序编写标准 21
exit() 21
异常 21
垃圾收集 22
final 类 22
访问类的成员变量 22
6 编程技巧 22
一般性原那么 22
检查所有参数输入的有效性。 23
检查参数输入 23
类名应准确描述类的功能。 23
防止强制返回值类型 23
让调用点显得易懂、容易理解。 23
减少数据类型转换 23
防止程序中的垃圾代码。 23
减少递归调用。 23
使用数据流图 24
防止使用BOOL参数。 24
开发过程中的技巧 24
byte 数组转换到 characters 24
Utility 类 24
初始化数组 24
枚举类型 25
Swing 25
Z-Order 问题 26
不必要的对象构造 26
synchronized 关键字 26
程序效率 26
注意代码的效率 26
提高代码效率 26
局部效率应为全局效率效劳 27
循环体内工作量最小化。 27
仔细分析有关算法，并进行优化。 27
改良输入方式 27
提高调用不频繁的代码效率要慎重 28
提高空间效率 28
循环的位置 28
尽量减少循环嵌套层次。 29
防止循环体内含判断语句 29
不要一味追求紧凑的代码。 30
7 性能 30
可移植性 30
换行 31
PrintStream 31
可测性 31
调测 31
调测信息串格式 31
在编程中注意单元测试 32
测试准备 32
测试手段 32
调测开关 32
调试与测试 32
调测开关的级别和类型 33
编写防错程序 33
8 质量保证 33
代码质量保证优先原那么 33
翻开的文件要关闭 33
一致性检查 34
switch语句必须有default分支。 34
其他质量问题 34
9 代码编辑、编译、审查 34
统一编译环境 34
代码走读及评审 34
QA代码抽查 35
软件系统目录 35
前言
为确保系统源程序可读性，从而增强系统可维护性，java编程人员应具有根本类似的编程风格，兹制定下述Java编程标准，以标准系统Java局部编程。系统继承的其它资源中的源程序也应按此标准作相应修改。
适用范围
本文档将作为java编程人员软件开发的编程格式标准。在工程Java局部的编码、测试及维护过程中，要求严格遵守。
命名标准
定义这个标准的目的是让工程中所有的文档都看起来像一个人写的，增加可读性，减少工程组中因为换人而带来的损失。
Package 的命名
Class 的命名
Class 的名字每个单词必须由大写字母开头而其他字母都小写的单词组成。例如：FileMng
Class 成员的命名
变量、方法、属性：大小写混排的单词组成，首字母小写
例如： functionName、countNum、size
Static Final 变量的命名
Static Final常量：大写单词组成，单词之间使用“_〞连接
例如： MAX_INDEX
前后台变量名称
前台变量 fg_变量名
后台变量 bg_变量名
参数的命名
参数的名字必须和变量的命名标准一