background image

定义这个规范的目的是让项目中所有的文档都看起来像一个人写的,增加可读性,减少项目组

中因为换人而带来的损失。

(这些规范并不是一定要绝对遵守,但是一定要让程序有良好的可读

)

Package 的命名
  

Package 的名字应该都是由一个小写单词组成。

  
Class 的命名
  

Class 的名字必须由

大写

字母开头而其他字母都小写的单词组成

  
Class 变量的命名
  变量的名字必须用一个小写字母开头。后面的单词用大写字母开头。
  
Static Final 变量的命名
  

Static Final 变量的名字应该都大写,并且指出完整含义。

  
参数的命名
  参数的名字必须和变量的命名规范一致。
  
数组的命名
  数组应该总是用下面的方式来命名

:

  

byte[] buffer;

  而不是

:

  

byte buffer[];

  
方法的参数
  使用有意义的参数命名,如果可能的话,使用和要赋值的字段一样的名字

:

  

SetCounter(int size){

  

this.size = size;

  

}

  
Java 文件样式
  所有的

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

  
版权信息
  版权信息必须在

 java 文件的开头,比如:

  

/**

  

* Copyright ?0?3 2000 Shanghai XXX 

Co

. Ltd.

  

* All right reserved.

  

*/

  其他不需要出现在

 javadoc 的信息也可以包含在这里。

  
Package/Imports