一、目的
▲統一公司軟件開發設計過程的編程規範。
▲使網站開發人員能很方便地理解每個目錄，變量，控件，類，方法的意義。
▲保證編寫出的程序都符合相同的規範，保證一致性，統一性。
▲編碼規範和約定必須能明顯改善代碼的可讀性，並有助於代碼管理，分類範圍適用於企業所有基於java平臺的軟件開發工作。
二、規範細節
1、代碼規範
（1）命名規則
▲一個唯一包名的的前綴總是全部小寫的ASCII字母。
▲類名是一個名詞，採用大小寫混合的方式，每個單詞的首字母大寫。
▲接口的大小寫規則與類名相似。
▲方法名是一個動詞，採用大小寫混合的方法，第一個單詞的首字母小寫，其後單詞的首字母大寫。
▲變量名中可以包含字母、下劃線（—）、數字、美元符號（$）、人民幣符號（￥），不能以數字開頭，變量名應簡短且富於描述，應該易於記憶，避免單個字符的變量名，除非是一次性的臨時變量，第一個單詞的首字母小寫。
▲常量的聲明應該全部大寫。
（2）註釋規範
▲所有的源文件都應該在開頭有一個註釋，其中列出文件名，日期和類的功能概述。
▲每個方法必須添加文檔註釋[累的main()方法除外]。
▲代碼或者實現細節需要15%的註釋量。
▲註釋使用中文。
（3）縮進排版規範
▲避免一行的長度超過60個字符。
▲使用MyEclipse的源代碼的格式化功能完成代碼的縮進排版。
（4）文件名規範
▲一個java源文件只能存儲一個公有型（public修飾）的java類。
▲文件名與公有型的java類名相同。
▲一個類文件的代碼行不超過200行。
（5）聲明規範
▲一行聲明一個變量。
▲不要將不同類型變量的聲明放在同一行。
▲只在代碼塊的開始處聲明變量。
▲方法與方法之間以空行分隔。
（6）語句規範
▲每行至多包含一條簡單語句。
▲if語句代碼塊總是用“{”和“}”括起來。
▲當在for語句的初始化或更新字句中使用逗號時，避免因使用三個以上的變量而導致複雜度提高。
▲每行switch的一個case自上向下執行時（因爲沒有break語句），通常應在break語句的位置添加註釋。
（7）編程規範
（1）原則
▲提供可視反饋。在後臺運行長進程時（時間超過10秒，視具體情況而定），必須提供進度條件等信息知識。
▲保證頁面能很快對用戶操作做出反應。
▲提供快捷鍵。
▲界面應該很簡單（不是過分單純化），易於學習，並且易於使用。
▲界面美觀，能夠吸引用戶。
▲對用一控件的規範要求應一致。
（2）命令行程序運行界面規範
▲背景爲白色，前景爲黑色。
▲字體爲宋體，24號。
（3）安全性規範
當三次輸入錯誤的驗證信息後，應該禁用該用戶的賬戶或暫時禁用。
（4）界面風格規範
▲用戶界面控件看起來應該是一致的。
▲將重要信息放在上面和左邊。
▲使用左對齊來使用戶界面控件更易於瀏覽。
▲不同界面中的同一功能應該使用同樣的圖標和圖片。圖標，圖片的色調與風格儘量保持一致。
▲截屏使用JPEG格式，1024x768x32位色彩。
▲使用統一的CSS。
（5）界面控制規範
▲總給列表框提供一個標籤，必須用標籤標明列表框的用途。
▲使列表框至少5行長，少於5行的列表沒有滑塊，不便於滾動。
▲將靜態文本標籤置於相關控件的左邊，而不是上面。
▲左對齊靜態文本標籤，左對齊使得標籤外觀更有條理，且易於瀏覽。
▲避免不好的背景，將文本放在實的，顏色適中的背景上，確保在文本和背景之間存在良好的對比。
▲採用日期和時間拾取空間進行日期輸入。
（6）字體規範
字體統一使用以下設置：字符集GBK，宋體。
（7）界面展示規範
▲數據按照列表顯示時，每頁數據不超過10行。
▲數據按照列表顯示時，首先爲選擇空間，其次爲數據信息，最後爲操作按鈕。
（8）界面操作規範
▲對輸入控件，如果沒有輸入，應給出提示的消息框。
▲對輸入控件，應給出相應的必填的提示標籤。
三、規範代碼樣例
/**
* 第一個java程序
*/
package s1java;
public class HelloBdqn{
private int classVar1; //類參數1
private Object classVar2; //類參數2
private int instanceVar; //實列參數2
private final int CONSTNUM = 5; //常量數
public static void main(String[] args){
//輸入對象的描述
System.out.println(new HElloBdqn());
}
/**
* 返回類實列的描述字符串
* @return 類實列的描述字符串
*/
public String toString(){
//返回一個描述用的字符串
return "Hello BDQN!";
}
/**
* 返回當前實例的classVar1屬性值
* @return classVar1屬性值
*/
public int getClassVar1(){
return classVar1;
}
/**
* 設置當前實例化的classVar1屬性值
* @param classVar1要設置的classVar1屬性值 */
public void setClassVar1(int classVar1){
this.classVar1 = classVar1;
}
}