怎么寫規(guī)范風(fēng)格良好的代碼(代碼規(guī)范參考版)_第1頁
怎么寫規(guī)范風(fēng)格良好的代碼(代碼規(guī)范參考版)_第2頁
怎么寫規(guī)范風(fēng)格良好的代碼(代碼規(guī)范參考版)_第3頁
怎么寫規(guī)范風(fēng)格良好的代碼(代碼規(guī)范參考版)_第4頁
全文預(yù)覽已結(jié)束

下載本文檔

版權(quán)說明:本文檔由用戶提供并上傳,收益歸屬內(nèi)容提供方,若內(nèi)容存在侵權(quán),請(qǐng)進(jìn)行舉報(bào)或認(rèn)領(lǐng)

文檔簡介

怎么寫規(guī)范風(fēng)格良好的代碼(參考版)一、整潔代碼概念代碼正確簡潔明了清晰易讀短小精確二、命名1.準(zhǔn)確:名字與意義匹配易于區(qū)別2.實(shí)用使用讀的出來的名稱使用可搜索的名稱3.明確一個(gè)概念對(duì)應(yīng)一個(gè)詞不用雙關(guān)語使用有意義的語境三、函數(shù)1.短小2.職責(zé)單一3.一塊代碼中,函數(shù)的抽象層級(jí)需一致4.函數(shù)命名規(guī)范(參照二)5.參數(shù)盡可能少6.如果函數(shù)需要的參數(shù)要求數(shù)量有多種,應(yīng)考慮將其封裝成類7.實(shí)用異常類代替返回錯(cuò)誤碼,抽離try/catch代碼塊,使代碼更加簡潔四、注釋1.少用注釋,盡可能通過規(guī)范的代碼來表達(dá)2.不使用無意義的注釋3.必要的注釋:法律信息提供信息的注釋對(duì)代碼意圖進(jìn)行解釋的注釋警示信息,防止踩坑TODO注釋:未來得及完成的部分對(duì)于無用的代碼應(yīng)直接刪除而不是注釋五、格式1.為什么需要規(guī)范格式易維護(hù)易拓展2.垂直格式行數(shù)少,短小精悍概念隔離,不同的的概念/邏輯代碼實(shí)用空行隔離相關(guān)靠近:對(duì)于關(guān)系緊密的代碼,盡量寫在一起3.水平格式縮進(jìn)、對(duì)齊六、對(duì)象與數(shù)據(jù)結(jié)構(gòu)1.區(qū)別:過程式代碼便于在不改動(dòng)既有數(shù)據(jù)結(jié)構(gòu)的前提下添加新函數(shù)面向?qū)ο蟠a便于在不改動(dòng)既有函數(shù)的前提下添加新類亦即:過程式代碼難以添加新數(shù)據(jù)結(jié)構(gòu),因?yàn)楸仨毿薷乃泻瘮?shù)面向?qū)ο蟠a難以添加新函數(shù),因?yàn)楸仨毿薷乃蓄惼摺㈠e(cuò)誤處理1.使用異常而非返回碼:更加美觀、整潔2.使用不可控異??煽禺惓5拇鷥r(jià)是違反開放/閉合原則,因?yàn)槟阈枰谑褂玫牡胤讲东@異常3.在異常發(fā)生的地方添加環(huán)境說明:這樣當(dāng)異常發(fā)生的時(shí)候就可以根據(jù)這些信息定位異常原因4.不返回null也不傳遞null這樣在接收的時(shí)候不需要進(jìn)行空值檢查八、邊界翻了下原書,邊界是Boundaries對(duì)于這個(gè)名字,開始不是大理解,就算現(xiàn)在看來也還是覺得不直觀標(biāo)題略晦澀:作者的意思應(yīng)該是讓我們讓自己的代碼和第三方庫代碼不要耦合太緊密,需有清新的邊界對(duì)于第三方類庫給的學(xué)習(xí)建議是:探索性地學(xué)習(xí)測(cè)試,以此熟悉類庫,寫出良好的代碼九、單元測(cè)試1.TDD定律在編寫不能通過的單元測(cè)試前,不可編寫生產(chǎn)代碼只可編寫剛好無法通過的單元測(cè)試,不能編譯也算不通過只可編寫剛好足以通過當(dāng)前失敗測(cè)試的生產(chǎn)代碼-----這三條寫的有點(diǎn)繞,我的理解就是:要把測(cè)試代碼當(dāng)生產(chǎn)代碼來寫,測(cè)試也很重要2.五大規(guī)則(F.I.R.S.T)快速:就是代碼質(zhì)量要好,高效獨(dú)立:不同測(cè)試之間應(yīng)相互獨(dú)立可重復(fù):就是在各種環(huán)境中都可測(cè)試通過自足驗(yàn)證:測(cè)試不依賴手工操作來知曉是否通過及時(shí):測(cè)試應(yīng)在生產(chǎn)代碼之前進(jìn)行編寫十、類主要注意一個(gè)點(diǎn),類應(yīng)短小,可通過以下兩種方式達(dá)到此目的:權(quán)責(zé)單一:一個(gè)類的權(quán)責(zé)不應(yīng)太多,太多則需考慮拆成多個(gè)類了高內(nèi)聚:類的實(shí)體變量應(yīng)盡可能少,類中方法盡可能多地使用到這些變量十一、系統(tǒng)1.系統(tǒng)構(gòu)造與使用分開工廠:使用工廠方法自行決定何時(shí)創(chuàng)建實(shí)例,但是構(gòu)造細(xì)節(jié)卻在其他地方依賴注入:當(dāng)A對(duì)B有依賴時(shí),A中不負(fù)責(zé)B的實(shí)例化(這就是類的權(quán)責(zé)單一原則)2.本章的后半部分提到的AOP,AspectJ等內(nèi)容都以Spring,EJB等框架為例十二、跌進(jìn)跌進(jìn)這一章提到的點(diǎn)不多1.運(yùn)行所有的測(cè)試:為能方便測(cè)試,我們的生產(chǎn)代碼也要足夠短小,耦合度低2.重構(gòu):在寫代碼過程中要及時(shí)重構(gòu),保持代碼的優(yōu)雅3.不可重復(fù):已有的代碼要利用起來,消除重復(fù)4.表達(dá)力強(qiáng):這應(yīng)該是一個(gè)目標(biāo)或是結(jié)果,做好前邊的工作自然而然可以達(dá)到十三、并發(fā)編程1.為什么:它可以將“目的”和“時(shí)機(jī)”分離,進(jìn)行解耦2.并發(fā)防御原則單一權(quán)責(zé):主要關(guān)注一點(diǎn),并發(fā)相關(guān)的代碼應(yīng)分離出來為此,三

溫馨提示

  • 1. 本站所有資源如無特殊說明,都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請(qǐng)下載最新的WinRAR軟件解壓。
  • 2. 本站的文檔不包含任何第三方提供的附件圖紙等,如果需要附件,請(qǐng)聯(lián)系上傳者。文件的所有權(quán)益歸上傳用戶所有。
  • 3. 本站RAR壓縮包中若帶圖紙,網(wǎng)頁內(nèi)容里面會(huì)有圖紙預(yù)覽,若沒有圖紙預(yù)覽就沒有圖紙。
  • 4. 未經(jīng)權(quán)益所有人同意不得將文件中的內(nèi)容挪作商業(yè)或盈利用途。
  • 5. 人人文庫網(wǎng)僅提供信息存儲(chǔ)空間,僅對(duì)用戶上傳內(nèi)容的表現(xiàn)方式做保護(hù)處理,對(duì)用戶上傳分享的文檔內(nèi)容本身不做任何修改或編輯,并不能對(duì)任何下載內(nèi)容負(fù)責(zé)。
  • 6. 下載文件中如有侵權(quán)或不適當(dāng)內(nèi)容,請(qǐng)與我們聯(lián)系,我們立即糾正。
  • 7. 本站不保證下載資源的準(zhǔn)確性、安全性和完整性, 同時(shí)也不承擔(dān)用戶因使用這些下載資源對(duì)自己和他人造成任何形式的傷害或損失。

最新文檔

評(píng)論

0/150

提交評(píng)論