JAVA代碼規(guī)范：
成都創(chuàng)新互聯(lián)公司專業(yè)為企業(yè)提供海西網(wǎng)站建設(shè)、海西做網(wǎng)站、海西網(wǎng)站設(shè)計(jì)、海西網(wǎng)站制作等企業(yè)網(wǎng)站建設(shè)、網(wǎng)頁設(shè)計(jì)與制作、海西企業(yè)網(wǎng)站模板建站服務(wù)，10余年海西做網(wǎng)站經(jīng)驗(yàn)，不只是建網(wǎng)站，更提供有價(jià)值的思路和整體網(wǎng)絡(luò)服務(wù)。
(1) 類名首字母應(yīng)該大寫。字段、方法以及對(duì)象（句柄）的首字母應(yīng)小寫。對(duì)于所有標(biāo)識(shí)符，其中包含的所有單詞都應(yīng)緊靠在一起，而且大寫中間單詞的首字母。例如：
ThisIsAClassName
thisIsMethodOrFieldName
若在定義中出現(xiàn)了常數(shù)初始化字符，則大寫static final基本類型標(biāo)識(shí)符中的所有字母。這樣便可標(biāo)志出它們屬于編譯期的常數(shù)。
Java包（Package）屬于一種特殊情況：它們?nèi)际切懽帜福幢阒虚g的單詞亦是如此。對(duì)于域名擴(kuò)展名稱，如com，org，net或者edu等，全部都應(yīng)小寫（這也是Java 1.1和Java 1.2的區(qū)別之一）。
(2) 為了常規(guī)用途而創(chuàng)建一個(gè)類時(shí)，請(qǐng)采取"經(jīng)典形式"，并包含對(duì)下述元素的定義：
equals()
hashCode()
toString()
clone()（implement Cloneable）
implement Serializable
(3) 對(duì)于自己創(chuàng)建的每一個(gè)類，都考慮置入一個(gè)main()，其中包含了用于測(cè)試那個(gè)類的代碼。為使用一個(gè)項(xiàng)目中的類，我們沒必要?jiǎng)h除測(cè)試代碼。若進(jìn)行了任何形式的改動(dòng)，可方便地返回測(cè)試。這些代碼也可作為如何使用類的一個(gè)示例使用。
(4) 應(yīng)將方法設(shè)計(jì)成簡(jiǎn)要的、功能性單元，用它描述和實(shí)現(xiàn)一個(gè)不連續(xù)的類接口部分。理想情況下，方法應(yīng)簡(jiǎn)明扼要。若長度很大，可考慮通過某種方式將其分割成較短的幾個(gè)方法。這樣做也便于類內(nèi)代碼的重復(fù)使用（有些時(shí)候，方法必須非常大，但它們?nèi)詰?yīng)只做同樣的一件事情）。
(5) 設(shè)計(jì)一個(gè)類時(shí)，請(qǐng)?jiān)O(shè)身處地為客戶程序員考慮一下（類的使用方法應(yīng)該是非常明確的）。然后，再設(shè)身處地為管理代碼的人考慮一下（預(yù)計(jì)有可能進(jìn)行哪些形式的修改，想想用什么方法可把它們變得更簡(jiǎn)單）。
(6) 使類盡可能短小精悍，而且只解決一個(gè)特定的問題。下面是對(duì)類設(shè)計(jì)的一些建議：
■一個(gè)復(fù)雜的開關(guān)語句：考慮采用"多形"機(jī)制
■數(shù)量眾多的方法涉及到類型差別極大的操作：考慮用幾個(gè)類來分別實(shí)現(xiàn)
■許多成員變量在特征上有很大的差別：考慮使用幾個(gè)類
(7) 讓一切東西都盡可能地"私有"--private?？墒箮斓哪骋徊糠?公共化"（一個(gè)方法、類或者一個(gè)字段等等），就永遠(yuǎn)不能把它拿出。若強(qiáng)行拿出，就可能破壞其他人現(xiàn)有的代碼，使他們不得不重新編寫和設(shè)計(jì)。若只公布自己必須公布的，就可放心大膽地改變其他任何東西。在多線程環(huán)境中，隱私是特別重要的一個(gè)因素--只有private字段才能在非同步使用的情況下受到保護(hù)。
(8) 謹(jǐn)惕"巨大對(duì)象綜合癥"。對(duì)一些習(xí)慣于順序編程思維、且初涉OOP領(lǐng)域的新手，往往喜歡先寫一個(gè)順序執(zhí)行的程序，再把它嵌入一個(gè)或兩個(gè)巨大的對(duì)象里。根據(jù)編程原理，對(duì)象表達(dá)的應(yīng)該是應(yīng)用程序的概念，而非應(yīng)用程序本身。
(9) 若不得已進(jìn)行一些不太雅觀的編程，至少應(yīng)該把那些代碼置于一個(gè)類的內(nèi)部。
(10) 任何時(shí)候只要發(fā)現(xiàn)類與類之間結(jié)合得非常緊密，就需要考慮是否采用內(nèi)部類，從而改善編碼及維護(hù)工作（參見第14章14.1.2小節(jié)的"用內(nèi)部類改進(jìn)代碼"）。
(11) 盡可能細(xì)致地加上注釋，并用javadoc注釋文檔語法生成自己的程序文檔。
(12) 避免使用"魔術(shù)數(shù)字"，這些數(shù)字很難與代碼很好地配合。如以后需要修改它，無疑會(huì)成為一場(chǎng)噩夢(mèng)，因?yàn)楦静恢?100"到底是指"數(shù)組大小"還是"其他全然不同的東西"。所以，我們應(yīng)創(chuàng)建一個(gè)常數(shù)，并為其使用具有說服力的描述性名稱，并在整個(gè)程序中都采用常數(shù)標(biāo)識(shí)符。這樣可使程序更易理解以及更易維護(hù)。
(13) 涉及構(gòu)建器和異常的時(shí)候，通常希望重新丟棄在構(gòu)建器中捕獲的任何異常--如果它造成了那個(gè)對(duì)象的創(chuàng)建失敗。這樣一來，調(diào)用者就不會(huì)以為那個(gè)對(duì)象已正確地創(chuàng)建，從而盲目地繼續(xù)。
(14) 當(dāng)客戶程序員用完對(duì)象以后，若你的類要求進(jìn)行任何清除工作，可考慮將清除代碼置于一個(gè)良好定義的方法里，采用類似于cleanup()這樣的名字，明確表明自己的用途。除此以外，可在類內(nèi)放置一個(gè)boolean（布爾）標(biāo)記，指出對(duì)象是否已被清除。在類的finalize()方法里，請(qǐng)確定對(duì)象已被清除，并已丟棄了從RuntimeException繼承的一個(gè)類（如果還沒有的話），從而指出一個(gè)編程錯(cuò)誤。在采取象這樣的方案之前，請(qǐng)確定finalize()能夠在自己的系統(tǒng)中工作（可能需要調(diào)用System.runFinalizersOnExit(true)，從而確保這一行為）。
(15) 在一個(gè)特定的作用域內(nèi)，若一個(gè)對(duì)象必須清除（非由垃圾收集機(jī)制處理），請(qǐng)采用下述方法：初始化對(duì)象；若成功，則立即進(jìn)入一個(gè)含有finally從句的try塊，開始清除工作。
(16) 若在初始化過程中需要覆蓋（取消）finalize()，請(qǐng)記住調(diào)用super.finalize()（若Object屬于我們的直接超類，則無此必要）。在對(duì)finalize()進(jìn)行覆蓋的過程中，對(duì)super.finalize()的調(diào)用應(yīng)屬于最后一個(gè)行動(dòng)，而不應(yīng)是第一個(gè)行動(dòng)，這樣可確保在需要基礎(chǔ)類組件的時(shí)候它們依然有效。
(17) 創(chuàng)建大小固定的對(duì)象集合時(shí)，請(qǐng)將它們傳輸至一個(gè)數(shù)組（若準(zhǔn)備從一個(gè)方法里返回這個(gè)集合，更應(yīng)如此操作）。這樣一來，我們就可享受到數(shù)組在編譯期進(jìn)行類型檢查的好處。此外，為使用它們，數(shù)組的接收者也許并不需要將對(duì)象"造型"到數(shù)組里。
(18) 盡量使用interfaces，不要使用abstract類。若已知某樣?xùn)|西準(zhǔn)備成為一個(gè)基礎(chǔ)類，那么第一個(gè)選擇應(yīng)是將其變成一個(gè)interface（接口）。只有在不得不使用方法定義或者成員變量的時(shí)候，才需要將其變成一個(gè)abstract（抽象）類。接口主要描述了客戶希望做什么事情，而一個(gè)類則致力于（或允許）具體的實(shí)施細(xì)節(jié)。
(19) 在構(gòu)建器內(nèi)部，只進(jìn)行那些將對(duì)象設(shè)為正確狀態(tài)所需的工作。盡可能地避免調(diào)用其他方法，因?yàn)槟切┓椒赡鼙黄渌烁采w或取消，從而在構(gòu)建過程中產(chǎn)生不可預(yù)知的結(jié)果（參見第7章的詳細(xì)說明）。
(20) 對(duì)象不應(yīng)只是簡(jiǎn)單地容納一些數(shù)據(jù)；它們的行為也應(yīng)得到良好的定義。
(21) 在現(xiàn)成類的基礎(chǔ)上創(chuàng)建新類時(shí)，請(qǐng)首先選擇"新建"或"創(chuàng)作"。只有自己的設(shè)計(jì)要求必須繼承時(shí)，才應(yīng)考慮這方面的問題。若在本來允許新建的場(chǎng)合使用了繼承，則整個(gè)設(shè)計(jì)會(huì)變得沒有必要地復(fù)雜。
(22) 用繼承及方法覆蓋來表示行為間的差異，而用字段表示狀態(tài)間的區(qū)別。一個(gè)非常極端的例子是通過對(duì)不同類的繼承來表示顏色，這是絕對(duì)應(yīng)該避免的：應(yīng)直接使用一個(gè)"顏色"字段。
(23) 為避免編程時(shí)遇到麻煩，請(qǐng)保證在自己類路徑指到的任何地方，每個(gè)名字都僅對(duì)應(yīng)一個(gè)類。否則，編譯器可能先找到同名的另一個(gè)類，并報(bào)告出錯(cuò)消息。若懷疑自己碰到了類路徑問題，請(qǐng)?jiān)囋囋陬惵窂降拿恳粋€(gè)起點(diǎn)，搜索一下同名的.class文件。
(24) 在Java 1.1 AWT中使用事件"適配器"時(shí)，特別容易碰到一個(gè)陷阱。若覆蓋了某個(gè)適配器方法，同時(shí)拼寫方法沒有特別講究，最后的結(jié)果就是新添加一個(gè)方法，而不是覆蓋現(xiàn)成方法。然而，由于這樣做是完全合法的，所以不會(huì)從編譯器或運(yùn)行期系統(tǒng)獲得任何出錯(cuò)提示--只不過代碼的工作就變得不正常了。
(25) 用合理的設(shè)計(jì)方案消除"偽功能"。也就是說，假若只需要?jiǎng)?chuàng)建類的一個(gè)對(duì)象，就不要提前限制自己使用應(yīng)用程序，并加上一條"只生成其中一個(gè)"注釋。請(qǐng)考慮將其封裝成一個(gè)"獨(dú)生子"的形式。若在主程序里有大量散亂的代碼，用于創(chuàng)建自己的對(duì)象，請(qǐng)考慮采納一種創(chuàng)造性的方案，將些代碼封裝起來。
(26) 警惕"分析癱瘓"。請(qǐng)記住，無論如何都要提前了解整個(gè)項(xiàng)目的狀況，再去考察其中的細(xì)節(jié)。由于把握了全局，可快速認(rèn)識(shí)自己未知的一些因素，防止在考察細(xì)節(jié)的時(shí)候陷入"死邏輯"中。
(27) 警惕"過早優(yōu)化"。首先讓它運(yùn)行起來，再考慮變得更快--但只有在自己必須這樣做、而且經(jīng)證實(shí)在某部分代碼中的確存在一個(gè)性能瓶頸的時(shí)候，才應(yīng)進(jìn)行優(yōu)化。除非用專門的工具分析瓶頸，否則很有可能是在浪費(fèi)自己的時(shí)間。性能提升的隱含代價(jià)是自己的代碼變得難于理解，而且難于維護(hù)。
(28) 請(qǐng)記住，閱讀代碼的時(shí)間比寫代碼的時(shí)間多得多。思路清晰的設(shè)計(jì)可獲得易于理解的程序，但注釋、細(xì)致的解釋以及一些示例往往具有不可估量的價(jià)值。無論對(duì)你自己，還是對(duì)后來的人，它們都是相當(dāng)重要的。如對(duì)此仍有懷疑，那么請(qǐng)?jiān)囅胱约涸噲D從聯(lián)機(jī)Java文檔里找出有用信息時(shí)碰到的挫折，這樣或許能將你說服。
(29) 如認(rèn)為自己已進(jìn)行了良好的分析、設(shè)計(jì)或者實(shí)施，那么請(qǐng)稍微更換一下思維角度。試試邀請(qǐng)一些外來人士--并不一定是專家，但可以是來自本公司其他部門的人。請(qǐng)他們用完全新鮮的眼光考察你的工作，看看是否能找出你一度熟視無睹的問題。采取這種方式，往往能在最適合修改的階段找出一些關(guān)鍵性的問題，避免產(chǎn)品發(fā)行后再解決問題而造成的金錢及精力方面的損失。
(30) 良好的設(shè)計(jì)能帶來最大的回報(bào)。簡(jiǎn)言之，對(duì)于一個(gè)特定的問題，通常會(huì)花較長的時(shí)間才能找到一種最恰當(dāng)?shù)慕鉀Q方案。但一旦找到了正確的方法，以后的工作就輕松多了，再也不用經(jīng)歷數(shù)小時(shí)、數(shù)天或者數(shù)月的痛苦掙扎。我們的努力工作會(huì)帶來最大的回報(bào)（甚至無可估量）。而且由于自己傾注了大量心血，最終獲得一個(gè)出色的設(shè)計(jì)方案，成功的快感也是令人心動(dòng)的。堅(jiān)持****草草完工的誘惑--那樣做往往得不償失
對(duì)于每個(gè)程序員來說，養(yǎng)成良好的代碼編寫方法是非常關(guān)鍵的。
在編寫代碼的過程中，每個(gè)人的方法是不同的，那么應(yīng)該如何規(guī)范自己代碼編寫的方法呢？規(guī)范編寫代碼有哪些要求呢？下面電腦培訓(xùn)帶大家認(rèn)識(shí)代碼編寫的方法。
一、保證代碼壓縮后不會(huì)出錯(cuò)對(duì)于大的JavaScript項(xiàng)目，一般來說，包含在項(xiàng)目中的所有JavaScript文件在產(chǎn)品公開時(shí)都會(huì)被壓縮。
為了正確壓縮代碼，通常需要考慮壓縮工具的必要條件，如句子用分號(hào)正常結(jié)束，中括號(hào)結(jié)束等。
因此，IT培訓(xùn)發(fā)現(xiàn)當(dāng)編寫代碼沒有按照標(biāo)準(zhǔn)進(jìn)行時(shí)，在發(fā)生壓縮錯(cuò)誤后再次尋找錯(cuò)誤是浪費(fèi)時(shí)間的。
二、保證代碼能夠通過自動(dòng)格式化功能一般情況下需要使用完善的開發(fā)工具進(jìn)行自動(dòng)化格式功能，這個(gè)功能能夠進(jìn)行換行、縮進(jìn)和空格等方法的代碼編排，并且還可以設(shè)置自己喜歡的格式。
別人在閱讀你的代碼時(shí)需要使用IDE進(jìn)行格式轉(zhuǎn)換，以滿足個(gè)人的閱讀風(fēng)格。
福建北大青鳥認(rèn)為閱讀代碼能夠更加深入的了解代碼調(diào)用和細(xì)節(jié)的實(shí)現(xiàn)，這是簡(jiǎn)單的文檔不能實(shí)現(xiàn)的。
三、使用標(biāo)準(zhǔn)的文檔注釋這是編寫代碼中最基本的要求，能夠很好的了解代碼的提示，并且還可以利用配套的文檔工具生產(chǎn)其他格式讓別人閱讀。
北大青鳥認(rèn)為編寫完整的注釋還可以使團(tuán)隊(duì)成員更容易閱讀您的代碼。
通過您的參數(shù)描述，團(tuán)隊(duì)成員很容易了解您想要傳遞參與實(shí)現(xiàn)細(xì)節(jié)和編寫的方法。
Java編碼規(guī)范: 盡量使用完整的英文描述符采用適用于相關(guān)領(lǐng)域的術(shù)語采用大小寫混合使名字可讀盡量少用縮寫，但如果用了，必須符合整個(gè)工程中的統(tǒng)一定義避免使用長的名字（小于15個(gè)字母為正常選擇）避免使用類似的名字，或者僅僅是大小寫不同的名字避免使用下劃線（除靜態(tài)常量等）標(biāo)識(shí)符類型說明包（Package）的命名Package的名字應(yīng)該采用完整的英文描述符，都是由一個(gè)小寫單詞組成。并且包名的前綴總是一個(gè)頂級(jí)域名
，通常是com、edu、gov、mil、net、org等；如：com.yjhmily.test類（Class）的命名類名應(yīng)該是個(gè)一名詞，采用大小寫混合的方式，每個(gè)單詞的首字母大寫。盡量保證類名簡(jiǎn)潔而富于描述。
大括號(hào)上下對(duì)齊比較好，這是華為的標(biāo)準(zhǔn)，推薦使用，這樣看上去很整潔規(guī)范，推薦用eclipse寫，可以導(dǎo)入編碼規(guī)范
{
代碼
}
對(duì)于程序員來說，養(yǎng)成良好的代碼寫作能力是非常重要的。
今天，我們就一起來了解一下，規(guī)范化的代碼編寫都有哪些要求。
希望通過對(duì)本文的閱讀，能夠提高大家對(duì)于代碼規(guī)范的認(rèn)識(shí)。
1.保證代碼壓縮后不出錯(cuò)對(duì)于大型的JSP項(xiàng)目，一般會(huì)在產(chǎn)品發(fā)布時(shí)對(duì)項(xiàng)目包含的所有JSP文件進(jìn)行壓縮處理，比如可以利用GoogleClosureCompilerService對(duì)代碼進(jìn)行壓縮，新版jQuery已改用這一工具對(duì)代碼進(jìn)行壓縮，這一般會(huì)去掉開發(fā)時(shí)寫的注釋，除去所有空格和換行，甚至可以把原來較長的變量名替換成短且無意義的變量名，這樣做的目的是加快文件的下載速度，同時(shí)也減小網(wǎng)站訪問帶來的額外數(shù)據(jù)流量，另外在代碼保護(hù)上也起到了一點(diǎn)點(diǎn)作用，至少壓縮后的代碼即使被還原還是沒那么容易一下讀懂的。
要想代碼能正確通過壓縮，一般要求語句都要以分號(hào)正常結(jié)束，大括號(hào)也要嚴(yán)格結(jié)束等，具體還要看壓縮工具的要求。
所以如果一開始沒有按標(biāo)準(zhǔn)來做，等壓縮出錯(cuò)后再回去找錯(cuò)誤那是浪費(fèi)時(shí)間。
2.保證代碼能通過特定IDE的自動(dòng)格式化功能一般較為完善的開發(fā)工具(比如AptanaStudio)都有代碼"自動(dòng)格式"化功能，這一功能幫助實(shí)現(xiàn)統(tǒng)一換行、縮進(jìn)、空格等代碼編排，你可以設(shè)置自己喜歡的格式標(biāo)準(zhǔn)，比如左大括號(hào){是否另起一行。
達(dá)到這個(gè)要求的目的在于方便你的開發(fā)團(tuán)隊(duì)成員拿你代碼的一個(gè)副本用IDE自動(dòng)格式化成他喜歡或熟悉的風(fēng)格進(jìn)行閱讀。
你同事需要閱讀你的代碼，可能是因?yàn)槟銓懙氖峭ㄓ梅椒?，他在其它模塊開發(fā)過程中也要使用到，閱讀你的代碼能深入了解方法調(diào)用和實(shí)現(xiàn)的細(xì)節(jié)，這是簡(jiǎn)單API文檔不能達(dá)到的效果。
3.使用標(biāo)準(zhǔn)的文檔注釋這一要求算是基本的，這有利于在方法調(diào)用處看到方法的具體傳參提示，也可以利用配套文檔工具生成html或其它格式的開發(fā)文檔供其他團(tuán)隊(duì)成員閱讀，你可以嘗試使用jsdoc-toolkit。
如果你自動(dòng)生成的API是出自一個(gè)開放平臺(tái)，就像facebook.com應(yīng)用，那么你的文檔是給天下所有開發(fā)者看的。
另外編寫完整注釋，也更方便團(tuán)隊(duì)成員閱讀你的代碼，通過你的參數(shù)描述，團(tuán)隊(duì)成員可以很容易知道你編寫的方法傳參與實(shí)現(xiàn)細(xì)節(jié)。
當(dāng)然也方便日后代碼維護(hù)，這樣即使再大的項(xiàng)目，過了很長時(shí)間后，回去改點(diǎn)東西也就不至于自己都忘記了當(dāng)時(shí)自己寫的代碼是怎么一回事了。
4.使用規(guī)范有意義的變量名使用規(guī)范有意義的變量名可以提高代碼的可讀性，作為大項(xiàng)目開發(fā)成員，自己寫的代碼不僅僅要讓別人容易看懂。
電腦培訓(xùn)認(rèn)為開發(fā)大項(xiàng)目，其實(shí)每個(gè)人寫的代碼量可能都比較大，規(guī)范命名，日后自己看回自己的代碼也顯的清晰易懂，比如日后系統(tǒng)升級(jí)或新增功能，修改起代碼來也輕松多了。
如果到頭發(fā)現(xiàn)自己當(dāng)初寫的代碼現(xiàn)在看不太懂了，那還真是天大的笑話了。
重慶分公司
重慶分公司
