Java开发代码的编写规范记要

一、java类命名规范

包package xxxyyyzzz

类class XxxYyyZzz

常量static final XXXYYYZZZ

变量/方法 var/func xxxYyyZzz

数组array typeName[]arrayName

 

二、Java 文件样式

（一）头部（版权信息）

版权信息必须在 java 文件的开头，其他一些需要说明的信息也写在这。

（二）Package/Imports

1.package

2.import标准

3.import本地

import 中包名按照字母顺序排列；

如果 import 行中包含了同一个包中的不同子目录，则应该用 * 来处理；

如果某一个包中引用的类不超过三个（包括三个），最好不要用import xxx.*;格式。

4.Class 类

写出类的文档注释，一般是用来解释类的相关信息，包括标题、描述。

4.1 Class Fields 类的成员变量

public 的成员变量必须生成文档（JavaDoc）。protected、private和 package 定义的成员变量如果名字含义明确的话，可以没有注释。

4.2存取方法

类变量的存取的方法。它只是简单的用来将类的变量赋值获取值的话，可以简单的写在一行上，其它的方法不要写在一行上

4.3构造函数

构造函数，它应该用递增的方式写（比如：参数多的写在后面）。访问类型 ("public", "private" 等.) 和任何"static", "final" 或"synchronized" 应该在一行中。

4.4类方法

 

三、其他

（一）页宽

页宽应该设置为80字符. 源代码一般不会超过这个宽度, 并导致无法完整显示, 但这一设置也可以灵活调整. 在任何情况下, 超长的语句应该在一个逗号或者一个操作符后折行. 一条语句折行后, 应该比原来的语句再缩进2个字符.

 

（二）权限修饰

 Java中权限修饰符有三个：public,private,protected，另外一种是不写这三种的任何一个，称为（default）.

1）对于外部类，只能用public或(default),而且一个文件中最多只能有一个public类。但是内部类这四种都可以使用。

2）如果对某些数据或方法只允许其所在类使用，用private修饰。

3）如果对某些数据或方法允许本类或同包类使用，用（default），即不写任何修饰符。

 

4）如果对某些数据或方法允许本类，同包类，或非同包子类使用，用protected.

5）如果对某些数据或方法允许任何类使用，用public修饰。

 

（三）性能优化

1、在写代码的时候，从头至尾都应该考虑性能问题，要注意代码的效率。

2、不必要的对象构造

3、不要在循环中构造和释放对象

4、使用 StringBuffer 对象（StringBuilder）

5、避免太多的使用 synchronized关键字

避免不必要的使用关键字synchronized，应该在必要的时候再使用她，这是一个避免死锁的好方法。

6、可移植性

为了保证整个系统的可移植性，尽量避免使用synchronized  关键字

7、PrintStream

PrintStream 已经被不赞成（deprecated）使用，用PrintWrite 来代替。

======================================================

书签：Java开发编码规范