1.1、命名規范

定義這個規范的目的是讓項目中所有的文檔格式統一，增強可讀性。

命名過程中，盡量使用英文單詞，較短的單詞可通過去掉“元音”形成縮寫，較長的單詞可取單詞的頭幾個字符，命名的目的是簡單易懂，不過于啰嗦。

n         Package命名

Package的名字應該都是由一個小寫單詞組成 例如：package com.neu.util;

n         Class 的命名

Class的名字必須由大寫字母開頭而其他字母都由小寫的單詞組成，其中包含的多有單詞都應緊靠在一起，而且大寫中間單詞的首字母。

例如：public class ThisAClassName{}

n         Class 變量和方法的命名

變量和方法的名字必須用一個小寫字母開頭。后面的單詞用大寫字母開頭

例如：userName,thisAClassMethod

n         Static final變量的命名

static final變量的名字應該都大寫，并且指出完整含義

例如：public static final String DB_CONFIG_FILE_PATH=“com.neu.etrain.dbconfig”；

n         參數的命名

參數的名字必須和變量的命名規范一致。使用有意義的參數命名，如果可能的話，使用和要賦值的字段一樣的名字：

Public void setSize(int size){

  this.size=size;

}

n         數組的命名

數組應該總是用下面的方式來命名：byte[] buffer;而不是:byte buffer[];方法的參數

1.2、變量定義規范

1.去掉沒必要的公共變量。

2.仔細定義并明確公共變量的含義、作用、取值范圍及公共變量間的關系。

3.明確公共變量與操作此公共變量的方法或過程的關系，如訪問、修改及創建等。

4.防止局部變量與公共變量同名。

5.嚴禁使用未經初始化的變量。聲明變量的同時對變量進行初始化。

1.3、代碼編寫格式

n         縮進

  縮進應該是每行一個Tab字符。在源文件中保存Tab字符，Tab字符占用2個字符

n         頁寬

  頁寬應該設置為80字符

n         {}對

   “{}”中的語句應該單獨作為一行。例如：

   If(i>0){

    i++;

}//單獨作為一行

‘}’語句永遠單獨作為一行，并且應該縮進到與其相對應的’{’那一行相對齊的位置。

n         括號

   左括號和后一個字符之間不應該出現空格，同樣，右括號和前一個字符之間也不應該出現空格。例如：CallProc(AParameter);

  不要在語句中使用無意義的括號。括號只應該為達到某種目的而出現在源代碼中。下面的例子說明錯誤和正確的用法：

If((i)=42){//錯誤-----括號毫無意義

If(I = = 42) or (j = = 42) then //正確----的確需要括號

1.4、注釋規范

Java的注釋有四種：

1.       注釋要簡單明了。String username=null；//用戶

2.       邊寫代碼邊注釋，修改代碼同時修改相應的注視，以保證注釋與代碼的一致性。

3.       在必要的地方注釋，注釋量要適中。注釋的內容要清楚、明了，含義準確，防止注釋二義性。保持注釋與其描述的代碼相鄰，即注釋的就近原則。

4.       對代碼的注釋應該放在其上方相鄰位置。

5.       全局變量要有較詳細的注釋，包括對其功能、取值范圍、哪些方法存取它以及存取時注意事項的說明。

6.       在每個源文件的頭部要有必要的注釋信息，包括：文件名；版本號；作者；生成日期；模塊功能描述（如功能、主要算法、內部各部分之間的關系、該文件與其它文件關系等）；主要方法清單及本文件歷史修改記錄等，如下

/**

  * @版權信息  : Neusoft IIT

  * @工程名    : eTrain

  * @JDK版本   : jdk6.0.1

  * @注釋      : config path

  * @詳細設計編號  : 1.01

  **/

7.在每個方法的前面要有必要的注釋信息，包括方法名稱；功能描述；輸入、輸出及返回值說明；拋出異常說明；調用關系及被調用關系說明等。

1.5、排版規范

在Eclipse開發環境下使用統一的排版格式（快捷鍵：Ctrl+Shift+f）.