后臺java程序編碼規(guī)范

《后臺java程序編碼規(guī)范》由會員上傳分享，免費在線閱讀，更多相關(guān)內(nèi)容在應用文檔-天天文庫。

1、Java程序編碼規(guī)范Java程序編碼規(guī)范后臺技術(shù)中心編寫人：汪源編寫時間：2009-3-27部門名：后臺技術(shù)中心-5-Java程序編碼規(guī)范修訂記錄編號修訂內(nèi)容簡述修訂日期版本修訂人1初始版本2009-3-270.1汪源-5-Java程序編碼規(guī)范總體約定1.一個工程中的所有文件應統(tǒng)一使用GBK或UTF-8編碼。2.代碼使用大小為4的TAB縮進。3.代碼使用package組織，package名應以com.netease.開關(guān)。4.使用Vector等集合框架類時，應指定模板類型參數(shù)。命名規(guī)范類名、文件名、枚舉變量等統(tǒng)一使用首字母大寫，如01classTableInfo{02...

2、03};函數(shù)參數(shù)、局部變量、函數(shù)名等統(tǒng)一使用Sun風格的命名，即第一個單詞小寫，其它單詞首字母大寫，如：01intmaxLength;04NtseIndex*primaryKey;05booldropTable(...){06//07}不允許使用匈牙利式命名法。常量統(tǒng)一使用全大寫，單詞之間用_連接，如:01staticfinalintNTSE_NAME_LEN;目錄名統(tǒng)一使用全小寫字母，單詞之間用-連接。語句主要是{放在同一行及空格使用上的約定。if/else形如（注意其中每個空格的位置）:01if(xxx){02...03}elseif(xxx){04...05}else

3、{06...07}-5-Java程序編碼規(guī)范for/while形如:01for(xxx;xxx;xxx){01...02}03while(xxx){04...05}switch形如:01switch(xxx){02caseaaa:03...04break;05casebbb:06...07break;08default:09break;10}函數(shù)定義形如:01intfoo(intp1,intp2){02...03}try/catch形如:01try{02...03}catch(SomeException&e){04...05}finally{06...07}空白基本的風格是

4、操作符的兩邊都要用空格，如:01a=b*2+c;但++/--操作與表達式之間不要用空格，如應使用:01i++;02i--;而不要使用-5-Java程序編碼規(guī)范01i++;02i--;;與,操作符應該前邊沒有空格，后邊有空格，如應使用:03for(i=0;i<100;i++)04some_func(arg1,arg2,arg3);而不要使用05for(i=0;i<100;i++)06some_func(arg1,arg2,arg3)注釋統(tǒng)一使用Java風格的注釋，如函數(shù)注釋形如：07/**函數(shù)簡要聲明08*09*[可選]函數(shù)詳細說明10*@pre先驗條件，在調(diào)用函數(shù)之前必須滿

5、足的條件11*@post后驗條件，函數(shù)完成之后必須滿足的條件12*@param參數(shù)1參數(shù)說明13*@param參數(shù)2參數(shù)說明14*...15*@throwSomeException異常說明16*@return返回值說明17*/注釋寫在哪里1.被子類重寫的虛函數(shù)的注釋應該寫在基類中，如果子類的實現(xiàn)沒有什么特殊之處，在子類中寫"@see基類函數(shù)"即可，沒有必要將一個注釋拷貝多份。各對象注釋規(guī)范開發(fā)人員應該為項目主體實現(xiàn)代碼中的所有類、類成員、函數(shù)等書寫完整的注釋。單元測試等非主體實現(xiàn)代碼的注釋要求由主管根據(jù)項目需要決定。代碼質(zhì)量2.進行良好的功能分解與模塊劃分，各模塊應擁有明確

6、單一的職責，遵循高內(nèi)聚低耦合的原則；-5-Java程序編碼規(guī)范1.保持代碼的封裝性，各模塊不應對外透露不必要的實現(xiàn)細節(jié)，使用各模塊時，防止依賴于模塊的內(nèi)部實現(xiàn)或?qū)δK的實現(xiàn)做各種假設；2.代碼重復是代碼中最最常見的問題，盡量消除重復代碼；3.保持代碼結(jié)構(gòu)盡可能的清晰，保證良好的可讀性，保持各類、函數(shù)、變量具有單純的功能；4.恰到好處的注釋，對于含義自明的代碼無需重復注釋（按規(guī)范要求必須包含的函數(shù)等說明注釋除外），代碼的目的或存在原因不太明確時應用注釋說明；5.函數(shù)體中適當?shù)氖褂每招袆澐殖龈鱾€邏輯上緊密聯(lián)系的段落是增強代碼可讀性的好方法；6.模塊規(guī)模較為龐大時，應考慮分離模塊

7、的主干流程代碼與非主干流程，這樣有助于保持主干流程代碼的簡潔性，增強對模塊整體上的掌控能力；7.不要保留大量的無用代碼、歷史遺留代碼等，代碼使用SVN管理，不會丟失；-5-