Java编程规范

一、Java命名约定

1、Java中的名称

包（Package）名、类（Class）名、接口（Interface）、变量名、方法名、常数名。

2、Java对于名称命名的约定的基本原则

_、$不作为变量名，方法名开头

变量名、方法名首单词小写，其余单词只有首字母大写，如anyVariableWorld

接口名、类名首单词第一个字母大写

常量：完全大写

3、各种命名原则

（1）包的命名规则

包名采用完整的英文描述符，应该都是由小写字母组成。如 com.taranis.graphics

（2）类、接口以及枚举类型的命名规则

类名、接口名以及枚举类型名都采用完整的英文描述符，并且所有单词的第一个字母大写。 如Customer, SavingsAccount

（3）变量的命名规则

类的属性（变量）采用完整的英文描述符，第一个字母小写，任何中间单词的首字母大写。 如firstName

方法的参数命名规则与属性的命名规则相同

局部变量的命名规则与属性的命名规则相同

（4）常量或静态常量（static final）

全部采用大写字母，单词之间用下划线分隔。如 MIN_BALANCE

（5）方法的命名规则

普通成员方法采用完整的英文描述说明成员方法功能，第一个单词要采用一个生动的动词，第一个字母小写。例如 openFile()

属性存取器方法采用访问属性名的前面加上前缀 get，如 getFirstName()；被访问字段名的前面加上前缀set， 如setFirstName()

（6）GUI组件的命名规则

首先使用完整的英文描述来说明组件的用途，其后加上组件类型， 如cancelButton

二、Java注释规则

1、基本原则

注释应该增加代码的清晰度

注释要简洁

在写代码之前写注释

注释中不仅指出代码做了什么，还要进一步指出这样作的原因

2、三类注释的使用

文档注释 /** */

C 语言风格注释 /* */

单行注释 //

三、Java源文件结构规则

Java 源文件(*.java)都必须遵守如下的样式规则：

版权信息必须在 java 文件的开头

package/imports 语句

类定义，可分为类注释、类声明和类体的定义

代码行缩进应该采用统一的单位

源文件页宽应该设置为80字符

“{ ”、“}”以及{}中的语句都应该单独一行。“{ ”应紧跟在它的所属语句的后面，“}”单独一行

左括号和后一个字符之间不应该出现空格； 同样， 右括号和前一个字符之间也不应该出现空格

使用一个空行来划分代码的逻辑组

四、编程建议

1、成员方法的30秒原则和第32条原则

其他编程人员应能够在30秒内完全理解方法的功能及实现过程

成员方法不要太长，一个成员方法体能够在一个屏幕（通常是32条语句）内显示

2、尽量减少公共(public)和受保护(protected)的接口

3、提高程序性能需注意的问题

不要在循环中创建和释放对象

使用 StringBuffer 对象

避免过多使用 synchronized 关键字

4、编写代码建议

注重程序的易读性，遵守编程规范，编写干净代码

先设计，后编码

一小步一小步的逐步开发

保持代码简洁