定義這個規(guī)範的目的是讓專案中所有的文?都看起來像一個人寫的，增加可讀性，減少專案組中因爲換人而帶來的損失。（這些規(guī)範並不是一定要?對遵守，但是一定要讓程式有良好的可讀性）

Package 的命名
Package 的名字應(yīng)該都是由一個小寫單詞組成。

Class 的命名
Class 的名字必須由大寫字母開頭而其他字母都小寫的單詞組成

Class 變數(shù)的命名
變數(shù)的名字必須用一個小寫字母開頭。後面的單詞用大寫字母開頭。

Static Final 變數(shù)的命名
Static Final 變數(shù)的名字應(yīng)該都大寫，並且指出完整含義。

參數(shù)的命名
參數(shù)的名字必須和變數(shù)的命名規(guī)範一致。

陣列的命名
陣列應(yīng)該總是用下面的方式來命名：
byte[] buffer;    
而不是：
byte buffer[];
    
方法的參數(shù)
使用有意義的參數(shù)命名，如果可能的話，使用和要賦?的欄位一樣的名字：
1234
 SetCounter(int size)
{ 
this.size = size;
}

Java 文件樣式
所有的 Java(*.java) 文件都必須遵守如下的樣式規(guī)則
版權(quán)資訊
版權(quán)資訊必須在 java 文件的開頭，比如：

/** * Copyright R 2000 XXX Co. Ltd. * All right reserved. */    
其他不需要出現(xiàn)在 javadoc 的資訊也可以包含在這?。

Package/Imports
package 行要在 import 行之前，import 中標準的包名要在本地的包名之前，而且按照字母順序排列。如果 import 行中包含了同一個包中的不同子目?，則應(yīng)該用 * 來處理。
123
 package hotlava.net.stats;
import java.io.*;
import java.util.Observable;import hotlava.util.Application; 

 
  
這兒java.io.* 使用來代替InputStream and OutputStream 的。
Class
接下來的是類的注釋，一般是用來解釋類的。
1
 /** * A class representing a set of packet and byte counters * It is observable to allow it to be watched, but only * reports changes when the current set is complete */ 

 
  
接下來是類定義，包含了在不同的行的 extends 和 implements
1
 public class CounterSet   extends Observable implements Cloneable 

 
  
Class Fields

接下來是類的成員變數(shù)：
123
 
/** * Packet counters */
protected int[] packets;

public 的成員變數(shù)必須生成文?（JavaDoc）。proceted、private和 package 定義的成員變數(shù)如果名字含義明確的話，可以沒有注釋。

存取方法
接下來是類變數(shù)的存取的方法。它只是簡單的用來將類的變數(shù)賦?獲取?的話，可以簡單的寫在一行上。
12345678910111213
 
/** * Get the counters * @return an array containing the statistical data.  This array has been * freshly allocated and can be modified by the caller. */public int[] getPackets() {
return copyArray(packets, offset);
}
public int[] getBytes() {
return copyArray(bytes, offset);
}
public int[] getPackets() {
 return packets;
}
public void setPackets(int[] packets) {
this.packets = packets;
 }

其他的方法不要寫在一行上

構(gòu)造函數(shù)
接下來是構(gòu)造函數(shù)，它應(yīng)該用遞增的方式寫（比如：參數(shù)多的寫在後面）。
訪問類型 ("public", "private" 等.) 和 任何 "static", "final" 或 "synchronized" 應(yīng)該在一行中，並且方法和參數(shù)?寫一行，這樣可以使方法和參數(shù)更易讀。
1234
 public CounterSet
(int size){ 
this.size = size;
}

克隆方法
如果這個類是可以被克隆的，那?下一?就是 clone 方法：
12345678910111213
 
public Object clone()
{ 
try {  
 CounterSet obj = (CounterSet)super.clone();  
 obj.packets = (int[])packets.clone();  
 obj.size = size;   
return obj; 
}
catch(CloneNotSupportedException e) {   
throw new InternalError("Unexpected CloneNotSUpportedException: " + e.getMessage()); 
}
}

類方法
下面開始寫類的方法：
12345678
 /** * Set the packet counters * (such as when restoring from a database) */
protected finalvoid setArray(int[] r1, int[] r2, int[] r3, int[] r4)  throws IllegalArgumentException
{ 
//  // Ensure the arrays are of equal size  //
 if (r1.length != r2.length || r1.length != r3.length || r1.length != r4.length)
  throw new IllegalArgumentException("Arrays must be of the same size");  System.arraycopy(r1, 0, r3, 0, r1.length); 
 System.arraycopy(r2, 0, r4, 0, r1.length);
}

toString 方法
無論如何，?一個類都應(yīng)該定義 toString 方法：
12345678910
 public String toString()
{ 
String retval = "CounterSet: ";  
 for (int i = 0; i < data.length(); i++) {    
   retval += data.bytes.toString();
      retval += data.packets.toString();
   }   
return retval; 
}
}

main 方法
如果main(String[]) 方法已經(jīng)定義了, 那?它應(yīng)該寫在類的底部.
代碼編寫格式

代碼樣式
代碼應(yīng)該用 unix 的格式，而不是 windows 的（比如：回車變成回車+換行）

文?化
必須用 javadoc 來爲類生成文?。不僅因爲它是標準，這也是被各種 java 編譯器都認可的方法。使用 @author 標記是不被推薦的，因爲代碼不應(yīng)該是被個人擁有的。

縮進
縮進應(yīng)該是?行2個空格. 不要在原始?案中保存Tab字元. 在使用不同的源代碼管理工具時Tab字元將因爲用?設(shè)置的不同而擴展爲不同的寬度.
如果?使用 UltrEdit 作爲?的 Java 源代碼編輯器的話，?可以通過如下操作來禁止保存Tab字元, 方法是通過 UltrEdit中先設(shè)定 Tab 使用的長度室2個空格，然後用 Format|Tabs to Spaces 功能表將 Tab 轉(zhuǎn)換爲空格。

頁寬
頁寬應(yīng)該設(shè)置爲80字元. 源代碼一般不會超過這個寬度, 並導(dǎo)致無法完整顯示, 但這一設(shè)置也可以靈活調(diào)整. 在任何情況下, 超長的語句應(yīng)該在一個逗號或者一個操作符後折行. 一條語句折行後, 應(yīng)該比原來的語句再縮進2個字元.

{} 對
{} 中的語句應(yīng)該單獨作爲一行. 例如, 下面的第1行是錯誤的, 第2行是正確的:
12
 if (i>0) { i ++ };
// 錯誤, { 和 } 在同一行

1234
  if (i>0) {
 i ++
 };
 // 正確, { 單獨作爲一行 } 語句永遠單獨作爲一行.

如果 } 語句應(yīng)該縮進到與其相對應(yīng)的 { 那一行相對齊的位置。

括弧
左括弧和後一個字元之間不應(yīng)該出現(xiàn)空格, 同樣, 右括弧和前一個字元之間也不應(yīng)該出現(xiàn)空格. 下面的例子?明括弧和空格的錯誤及正確使用:
12
 CallProc( AParameter ); // 錯誤
CallProc(AParameter); // 正確

不要在語句中使用無意義的括弧. 括弧只應(yīng)該爲達到某種目的而出現(xiàn)在源代碼中。下面的例子?明錯誤和正確的用法:
12
 if ((I) = 42) { // 錯誤 - 括弧毫無意義
if (I == 42) or (J == 42) then // 正確 - 的確需要括弧

程式編寫規(guī)範
exit()
exit 除了在 main 中可以被調(diào)用外，其他的地方不應(yīng)該調(diào)用。因爲這樣做不給任何代碼代碼機會來截獲退出。一個類似後臺服務(wù)地程式不應(yīng)該因爲某一個庫模組決定了要退出就退出。

異常
申明的錯誤應(yīng)該拋出一個RuntimeException或者派生的異常。
頂層的main()函數(shù)應(yīng)該截獲所有的異常，並且列印（或者記?在日誌中）在螢?zāi)簧稀?

??收集
JAVA使用成熟的後臺??收集技術(shù)來代替引用計數(shù)。但是這樣會導(dǎo)致一個問題：?必須在使用完物件的實例以後進行清場工作。比如一個prel的程式師可能這?寫：
1234
   ...  {
    FileOutputStream fos = new FileOutputStream(projectFile);
    project.save(fos, "IDE Project File");
   }  ...

除非輸出流一出作用域就關(guān)閉，非引用計數(shù)的程式語言，比如JAVA，是不能自動完成變數(shù)的清場工作的。
必須象下面一樣寫：
  FileOutputStream fos = new FileOutputStream(projectFile);
  project.save(fos, "IDE Project File");
  fos.close();
Clone
下面是一種有用的方法：
1234567891011
   implements Cloneable  public    Object clone()    { 
    try {
       ThisClass obj = (ThisClass)super.clone();
        obj.field1 = (int[])field1.clone();
        obj.field2 = field2;
        return obj;
     }
catch(CloneNotSupportedException e) {
        throw new InternalError("Unexpected CloneNotSUpportedException: " + e.getMessage());
      }
 }

final 類
?對不要因爲性能的原因?qū)㈩惗x爲 final 的（除非程式的框架要求）
如果一個類還沒有準備好被繼承，最好在類文?中注明，而不要將?定義爲 final 的。這是因爲沒有人可以保證會不會由於什?原因需要繼承?。

訪問類的成員變數(shù)
大部分的類成員變數(shù)應(yīng)該定義爲 protected 的來防止繼承類使用他們。
注意，要用"int[] packets"，而不是"int packets[]"，後一種永遠也不要用。
1234567
 
public void setPackets(int[] packets) {
this.packets = packets;
}
 CounterSet(int size){
this.size = size;
}

 

文件構(gòu)成	文件路徑	模塊位置	文件應(yīng)當屬于他所在的模塊（serivce,dao…… ）目錄。	●
		機能位置	文件屬于他所對應(yīng)的機能目錄。	●
命名規(guī)則	包名	包名	首字母小寫，名詞方式或者編號方式命名	●
	類名	類名	首字母大寫，單詞第一個字母大寫。	●
	常量	常量	定義為靜態(tài)（static），定義為終結(jié)（final）			●
		常量名	常量名全部使用大寫，單詞間使用（_）分割			●
	方法名	無返回值方法名	首字母小寫，機能方式命名。			●
		其他類型方法名	首字母小寫	●
		Boolean型方法名	is+形容詞，can+動詞，has+名詞/動詞過去式			●
	變量名	Boolean型變量名	is+形容詞，can+動詞，has+名詞/動詞過去式			●
		其他類型變量名	首字母小寫	●
	英文	拼寫正確	英語單詞拼寫正確	●
	對稱性	命名單詞對稱	add/remove insert/delete insert/delete start/stop begin/end ……			●
	循環(huán)用變量	循環(huán)用變量命名	根據(jù)使用次序按照i j k l m n 依次使用	●
	臨時變量	臨時變量命名	使用該變量類型每個單詞的首字母小寫命名，如（ServeletContext sc;） 使用該變量類型名，將該名稱首字母小寫，如（Array array; 或者 Array arr;）	●
	方法參數(shù)	方法參數(shù)命名	定義方式參照變量名定義。參數(shù)名能夠表示該參數(shù)的含義。	●
	內(nèi)部變量	內(nèi)部變量命名	用于保存公開變量（publci String getXXX()）的內(nèi)部變量，使用XXX作為變量名命名（但首字母要小寫）
編程樣式	注釋	注釋方式	單行注釋使用"http://"+空格+注釋內(nèi)容。多行注釋使用/*...*/。	●
	縮進方式	縮進方式	使用1個tab進行縮進處理	●
	括號方式	類	起始括號位于類定義行末尾，結(jié)束括號單獨一行，與類定義對齊。	●
		方法	起始括號位于方法定義行末尾，結(jié)束括號單獨一行，與方法定義對齊。	●
		程序分支	起始括號位于分支定義行末尾，結(jié)束括號單獨一行，與分支定義對齊。	●
	行的長度	行的長度	每行程序的長度不得超過80個字符。	●
	private	使用范圍	除去公開方法或者屬性外，應(yīng)當全部定義為private。	●
	protected	使用范圍	共通類/方法以外，沒有特殊要求，不得使用protected定義。	●
	public	使用范圍	允許外部訪問和修改的方法/變量。	●
	if/while	"="符號的使用	在if/while語句的判斷式內(nèi)，不能使用"="符號。	●
		"< > <= >="的使用	在同一個判斷式中的多個部分內(nèi)，不允許同時出現(xiàn)"<"和">"（判斷方向必須一致）	●
	循環(huán)處理	循環(huán)處理嵌套	循環(huán)處理不允許嵌套3層以上。	●
	循環(huán)變量	循環(huán)變量	不允許多個循環(huán)代碼使用同一個變量作為循環(huán)參數(shù)。	●
	文件注釋	注釋方式	使用多行注釋	●
		改版履歷	式樣變更的改版履歷，內(nèi)容有（時間，式樣版本，對應(yīng)者）			●
	類注釋	注釋方式	使用多行注釋	●
		機能說明	對機能進行簡單說明。	●
		創(chuàng)建者	記錄創(chuàng)建者（@author）	●
	方法注釋	注釋方式	使用多行注釋	●
		機能說明	對機能進行簡單說明。		●
		參數(shù)說明	對參數(shù)和返回值進行簡單說明。		●
	變量注釋	注釋方式	使用單行注釋	●
其他	判斷式	判斷式	使用"< > = && ||"等判斷式組成多次組合判斷時，使用括號標明判斷式執(zhí)行次序。	●