編程規約一

標籤：eclipse   類型   print   append   for   緩衝   app   維護   可擴充性   

　　大廠比較重視代碼規範，尤其是可擴充性和可維護性，以及可讀性。如果你是一個剛進公司的開發人員，最好先問問前輩是否有

內部的開發規範，花點時間過一遍。即使提交代碼沒有review的步驟，自己心裡應該有個規範。業內比較統一的此處不總結。

　　一 、命名風格

　　1、抽象類別以Abstract或Base開頭，異常類以Exception結尾，枚舉類以Enum結尾，常量類以Consts結尾，測試類別以Test結尾

　　2、數組定義中類型與中括弧緊挨 int[] arr;

　　3、POJO類中布爾類型的變數，都不要加is首碼

　　4、包名使用單數形式，類名若有複數含義可用複數形式，如Utils

　　5、除非業內公認的縮寫，單詞不要縮寫

　　6、若使用了設計模式，以模式名結尾，如OrderFactory,ServiceProxy

　　7、介面類的方法和屬性不要加任何修飾符號，1.8以前的方法預設都是public abstract 修飾，屬性都是public static final的

1.8及以後的加入了static和default修飾符，這兩種修飾的方法都需要方法體

　　8、介面和實作類別：XxxService，XxxServiceImpl，XxxDao，XxxDaoImpl

　　9、結構分層的類的方法命名：

　　　　（1）擷取單個對象用get做首碼 getObject

　　　　（2）擷取多個對象用list做首碼+複數形式結尾 listObjects

　　　　（3）擷取統計值用count做首碼

　　　　（4）插入方法用save/insert做首碼

　　　　（5）刪除用remove/delete做首碼

　　　　（6）修改用update做首碼

　　　　（7）2種VO：資料表對象xxxDO,網頁視圖對象xxxVO

　　二、常量定義

　　1、long型賦值以大寫的L結尾，以免數字1與小寫字母l混淆

　　2、常量類也要分類，不要全部放在一起。比如緩衝相關的常量用CacheConsts,系統配置相關的用ConfigConsts，

這些類均放在constant包下，類內部的常量放在本類中使用，不要公開出來放在常量類中

　　3、變數值僅在一個固定範圍內變化的，用enum類型定義。比如常見的資料庫欄位值的漢字轉義

　　三、代碼格式

　　1、大括弧，看樣本：（另外左側大括弧與字元留一個空格）　　　

int a(){};int a(){    System.out.println("1");}int a(int b){    if(b==1){        System.out.println("1");     }else if(b==2){        System.out.println("2");     }else{        System.out.println("3");     }  }        

　　2、小括弧，左右小括弧與字元都不留空格。if/for/while等保留字與括弧加一個空格

　　3、運算子左右都加一個空格

　　4、使用統一的Tab縮排，自行在IDE等開發工具上提前設定

　　5、換行：運算子以及點號調用符與下文一起換行，參數換行在逗號後換行。最常見的是append("xxx")方法

　　6、IDE統一設定text file encoding為utf-8;分行符號使用Unix格式，不要用Windows格式

　　7、方法總行數不要過多，一般建議是80行，額外邏輯應提取出來獨立一個方法，使主幹邏輯清晰

　　8、除了邏輯或者業務意義需要加一個空行來隔開，其他的情況不要出現無意義的空行

最後：Intellij類寫完了一定要按Ctrl+Alt+O,Ctrl+Alt+L;  Eclipse類寫完了一定要按Ctrl+Shift+F，否則你一定要良心過不去

 

編程規約一