Java代碼規(guī)范檢查表范本

#Java代碼規(guī)范檢查表項(xiàng)目名稱項(xiàng)目編號檢查人檢查日期被檢查人檢查內(nèi)容檢查依據(jù)檢查類別檢查規(guī)模檢查耗時(shí)規(guī)范編號檢查項(xiàng)級別缺陷數(shù)量缺陷描述1所有包、類、接口、方法、屬性、變量、參數(shù)均使用英文單詞或易理解的縮與進(jìn)行命名。強(qiáng)制2命名包、類、接口、方法以及變量時(shí)，盡量使用貼近問題域的表意豐富的名稱。強(qiáng)制3修改源代碼時(shí)，應(yīng)盡量保持與所修改系統(tǒng)的編碼風(fēng)格保持一致。強(qiáng)制4所有包名使用必須使用com.esse前綴，所有項(xiàng)目使用jects.<projectname〉,projectname是項(xiàng)目的縮寫，比如外理jects.tally,中塑jects.cpinfo。強(qiáng)制5為了保證工作效率，如遇本規(guī)范中的格式規(guī)范與eclipse的默認(rèn)規(guī)范不一致，應(yīng)使用eclipse默認(rèn)格式規(guī)范。強(qiáng)制

6包的導(dǎo)入應(yīng)該按照相關(guān)性進(jìn)行分組。強(qiáng)制7只導(dǎo)入明確需要的類，這樣只要看導(dǎo)入列表，就可以知道該類依賴于哪些類和接口，保證可讀性。強(qiáng)制8類和按口中元糸的布局順序。強(qiáng)制9類的聲明，基類和實(shí)現(xiàn)的接口在一行顯示不下時(shí)，應(yīng)該獨(dú)立成行，保證可讀性。推薦10方法修飾關(guān)鍵字定義順序。強(qiáng)制11變量聲明，采用camel表示法，不要在一行聲明多個(gè)變量。強(qiáng)制12保證明確的類型轉(zhuǎn)換，不要默認(rèn)進(jìn)行隱式類型轉(zhuǎn)換。強(qiáng)制13數(shù)組指示符緊跟類型變量。強(qiáng)制14—個(gè)變量要代表獨(dú)立的意思，不要在其生命周期賦予它不同的概念。強(qiáng)制15僅僅循環(huán)控制變量才能出現(xiàn)在for()循環(huán)中。強(qiáng)制16循環(huán)變量應(yīng)靠近循環(huán)體初始化。強(qiáng)制17避免長的布爾表達(dá)式，應(yīng)該換成多個(gè)更容易理解的表達(dá)式。如考慮到效率原因而使用短路規(guī)則，可以違背此規(guī)范。強(qiáng)制18不要在條件語句中執(zhí)行方法，以提高可讀性。推薦19代碼縮進(jìn)，應(yīng)該使用4個(gè)空格為一個(gè)單位進(jìn)行縮進(jìn)。強(qiáng)制

20條件語句的主要形式，即使單條語句，也要使用括號括起來。強(qiáng)制21空循環(huán)體也要使用完整的｛｝塊。強(qiáng)制22switch語句的使用格式。強(qiáng)制23trycatch使用格式。強(qiáng)制24空格的使用。強(qiáng)制25空行的使用。強(qiáng)制26邏輯上緊密相關(guān)的代碼塊應(yīng)該用一個(gè)空行分開。強(qiáng)制27為了保證可讀性，變量名應(yīng)該左對齊。推薦28像前面一般規(guī)則里說的那樣，任何提高代碼可讀性的排版都可以去嘗試。推薦29當(dāng)對if語句中的條件進(jìn)行折行時(shí)，應(yīng)該使折行的條件語句相對主功能語句再行縮進(jìn)4個(gè)空格，以突出主要功能語句。強(qiáng)制30二兀條件運(yùn)算符。強(qiáng)制31包名應(yīng)該用小寫字母，不要出現(xiàn)下劃線等符號，名詞用有意義的縮與或者英文單詞。強(qiáng)制32所有類命名使用Pascal表示方式，使用名詞組合。強(qiáng)制33接口命名使用字母“I”加上Pascal形式的表示方式。強(qiáng)制34使用名詞組合或形容詞去命名一個(gè)接口，接口聲明了一個(gè)對象能提供的服務(wù)，也描述了一個(gè)對象的能推薦

力。一般以“able，和“ible，作為后綴，代表了一種能力。35變量名和參數(shù)名使用camel表示方式。強(qiáng)制36對于常量名，使用大與字母，并使用下劃線做間隔。強(qiáng)制37方法名應(yīng)該使用動(dòng)詞開頭，使用camel表示方式，—般由動(dòng)詞+名詞組成。強(qiáng)制38縮與字母也應(yīng)該保持首字母大與。強(qiáng)制39變量的名字應(yīng)該盡可能和類型名稱一致。推薦40根據(jù)變量的作用范圍，作用范圍大的應(yīng)使用長名稱，作用范圍大，表明變量的生命周期比較長，為了有助于理解，應(yīng)盡量用長名稱以表達(dá)變量的真實(shí)意圖。反之，對于作用范圍小，可以使用一些簡化的名稱，比如i、j、k等，提高編程效率。強(qiáng)制41使用get/set對類屬性進(jìn)行訪問，這是Java社區(qū)的核心編碼規(guī)范。強(qiáng)制42使用is刖綴表示個(gè)布爾變量和方法。強(qiáng)制43在杳詢方法中應(yīng)使用find作為刖綴。推薦44使用initialize做為對象初始化的方法刖綴，也可以簡寫為init。推薦45對于對象集合，變量名稱應(yīng)使用復(fù)數(shù)。強(qiáng)制46對于抽象類，應(yīng)該使用Abstract刖綴，對于非抽象強(qiáng)制

基類，可以使用Base前綴。47對丁表示編號的變量，應(yīng)加No后綴。強(qiáng)制48常在一起使用的對稱詞匯，這些詞匯一起使用，方法的表達(dá)意圖自然可以互相推測和演繹。強(qiáng)制49避免使用否定布爾變量。推薦50異常類應(yīng)該使用Exception做為后綴。強(qiáng)制51缺省接口實(shí)現(xiàn)應(yīng)該使用Default刖綴。推薦52對于單例類(Singleton)/應(yīng)該使用getlnstance方法得到單例。推薦53對于工廠類，進(jìn)行創(chuàng)建對象的方法，應(yīng)該使用New前綴。推薦54代碼應(yīng)該和注釋保持同步。強(qiáng)制55注釋盡量簡潔。強(qiáng)制56接口中的方法定要編與注釋。強(qiáng)制57注釋應(yīng)使用正式的JavaDoctags風(fēng)格的注釋。強(qiáng)制58代碼的版權(quán)信息。強(qiáng)制59類注釋，描述類的主要職責(zé)和用處。強(qiáng)制60對于public方法和長方法應(yīng)進(jìn)行注釋，描述方法是做什么的，如何調(diào)用，最好給出調(diào)用代碼示例。強(qiáng)制61復(fù)雜的算法、長方法的實(shí)現(xiàn)要編寫內(nèi)部實(shí)現(xiàn)注釋，從為什么要這么做角度去描述。強(qiáng)制62盡可能在類描述中加入代碼調(diào)用示例，使用推薦

<pre></pre>標(biāo)記，提示JavaDoc工具不要改變格式。63對已經(jīng)正式發(fā)布版本中的代碼進(jìn)行修改和維護(hù)時(shí)，應(yīng)該在修改處進(jìn)行內(nèi)部注釋并注明修改人、修改時(shí)間、修改意圖以及應(yīng)注意問題等。強(qiáng)制64使用@deprecated廢棄方法，不要?jiǎng)h掉匕。推薦65使用行末注釋對深層嵌套代碼進(jìn)行注釋。推薦66所有變量都應(yīng)該進(jìn)行初始化。強(qiáng)制67變量在使用刖應(yīng)進(jìn)行合法性檢杳。強(qiáng)制68靜態(tài)變量和方法的使用應(yīng)保證線程安全。強(qiáng)制69所有異常應(yīng)該被正確的處理，不應(yīng)簡單的吞掉異?；虼蛴x.printStackTrace()。應(yīng)該將異常記入日志或者包裝后向上層拋出。對于表現(xiàn)層頁面，不應(yīng)該出現(xiàn)程序異常，應(yīng)該在捕獲到異常后進(jìn)行友好的提示。強(qiáng)制70對于靜態(tài)方法，應(yīng)該使用類名去使用，不應(yīng)該用實(shí)例去引用，主要是為了體現(xiàn)更多的語義。強(qiáng)制71對一些基本數(shù)據(jù)類型和不太可能通過繼承進(jìn)行擴(kuò)展的類，應(yīng)聲明為final，提高效率。推薦72類和方法的粒度保持適中，保持類的規(guī)模盡量短小，職責(zé)單。小類有很多好處，易于設(shè)計(jì)，易于測試，易于理解。同樣方法也要盡量的小，每個(gè)方法盡量不要超出25行。推薦

73開閉原則，軟件應(yīng)該對擴(kuò)展開放，對修改關(guān)閉。也就是說，應(yīng)該在不修改以前源代碼的基礎(chǔ)上，改變程序的行為以適應(yīng)新的需求。推薦74里氏代換原則：假設(shè)有兩個(gè)類，一個(gè)是基類Base，個(gè)是派生類Derived，如果個(gè)方法可以接受基類對象b的話：methodl（Baseb）,同樣，這個(gè)方法也應(yīng)該接受派生類Derived的對象d，而不影響方法的行為。里氏代換原則是繼承復(fù)用的基石。推薦75抽象依賴原則（穩(wěn)定依賴原則）。應(yīng)該依賴于抽象而不依賴于具體類，抽象的類和接口是穩(wěn)定的，而具體類是易變的，如果依賴于具體類，代碼就會(huì)非常脆弱，失去了靈活性。推薦76接口隔離原則，-個(gè)類對另外一個(gè)類的依賴應(yīng)該建立在最小的接口之上的。推薦77單職責(zé)原則，如果個(gè)類有多于種的職責(zé)，當(dāng)需求變化時(shí)，類的職責(zé)就要發(fā)生變化，而因此就會(huì)引起引用該類的代碼發(fā)生改變，職責(zé)越多，這個(gè)類就容易跟更多的類產(chǎn)生耦合關(guān)系，而且改變一個(gè)職責(zé)，可能會(huì)影響到另外一個(gè)職責(zé)的履行。推薦78編寫代碼前，先編寫注釋（可以認(rèn)為是偽代碼）,先想后寫。推