代碼整潔之道讀書筆記PPT

讀書交流會多讀書好讀書讀好書,1,舉頭望明月低頭敲代碼滿園春色關(guān)不住一串代碼飄出來夜闌臥聽風(fēng)雨聲做夢還在敲代碼洛陽親友如相問就說我在敲代碼風(fēng)蕭蕭兮易水寒壯士要去敲代碼松下問童子言師敲代碼白發(fā)三千丈Bug改不完垂死病中驚坐起今天還沒敲代碼在天愿做比翼鳥在地愿意敲代碼但愿人長久天天敲代碼,獻(xiàn)給廣大不辭辛勞的程序員們,2,閱讀本書有兩種原因第一，你是個程序員第二，你想成為更好的程序員,3,主要內(nèi)容,混亂代碼的代價整潔代碼藝術(shù)、什么是整潔代碼如何編寫整潔代碼,4,混亂代碼的代價,YourTextHere,YourTextHere,一、要有代碼有人說過我們正在臨近代碼的終結(jié)點(diǎn)?？齑a就會自動產(chǎn)生出來不需要再人工編寫。程序員完全沒用了因?yàn)樯虅?wù)人士可以從規(guī)約直接生成程序。,代碼呈現(xiàn)了需求的細(xì)節(jié)。,5,混亂代碼的代價,二、糟糕代碼你是否曾為糟糕的代碼所深深困擾？如果你是位有點(diǎn)兒經(jīng)驗(yàn)的程序員，定然多次遇到過這類困境。我們有專用來形容這事的詞：沼澤。我們趟過代碼的水域。我們穿過灌木密布、瀑布暗藏的沼澤地。我們拼命想找到出路，期望有點(diǎn)什么線索能啟發(fā)我們到底發(fā)生了什么事，但目光所及，只是越來越多死氣沉沉的代碼。,6,混亂代碼的代價,隨著混亂的增加，團(tuán)隊(duì)生產(chǎn)力也持續(xù)下降趨向于零。當(dāng)生產(chǎn)力下降時，管理層就只有一件事可做了，增加更多人手到項(xiàng)目中，期望提升生產(chǎn)力?？墒切氯瞬⒉皇煜は到y(tǒng)的設(shè)計。他們搞不清楚什么樣的修改符合設(shè)計意圖，什么樣的修改違背設(shè)計意圖。而且，他們以及團(tuán)隊(duì)中的其他人都背負(fù)著提升生產(chǎn)力的可怕壓力。于是，他們制造更多的混亂，驅(qū)動生產(chǎn)力向零那端不斷下降。,7,混亂代碼的代價,將需求明確到機(jī)器可以執(zhí)行的程度，就是編程要做的事，這種規(guī)約就是代碼。糟糕的代碼可能毀掉一家公司?；靵y代碼的代價是驅(qū)動生產(chǎn)力不斷趨向零。整潔不僅與效率有關(guān)，而且關(guān)于企業(yè)的生存。,什么樣的代碼是整潔代碼？,8,整潔代碼,代碼邏輯應(yīng)當(dāng)直截了當(dāng)，叫缺陷難以隱藏，盡量減少依賴關(guān)系，使之便于維護(hù)，依據(jù)某種分層戰(zhàn)略完善錯誤處理代碼，性能調(diào)至最優(yōu)，省得引誘別人做沒規(guī)矩的優(yōu)。整潔的代碼簡單直接。整潔的代碼如同優(yōu)美的散文。整潔的代碼從不隱藏設(shè)計者的意圖，充滿了干凈利落的抽象和直截了當(dāng)?shù)目刂普Z句。果斷決絕。代碼應(yīng)當(dāng)講述事實(shí)不引人猜測。它只該包含必需之物。它應(yīng)當(dāng)有單元測試和驗(yàn)收測試。它使用有意義的命名。它只提供一種而非多種做一件事的途徑。它只有盡量少的依賴關(guān)系而且要明確地定義和提供清晰、盡量少的API。代碼應(yīng)通過其字面表達(dá)含義因?yàn)椴煌恼Z言導(dǎo)致并非所有必需信息均可通過代碼自身清晰表達(dá)。,9,整潔代碼,沒有測試的代碼不干凈。不管它有多優(yōu)雅不管有多可讀、多易理解微乎測試其不潔亦可知也。整潔的代碼總是看起來像是某位特別在意它的人寫的。幾乎沒有改進(jìn)的余地。代碼作者什么都想到了如果你企圖改進(jìn)它總會回到原點(diǎn)。能通過所有測試；沒有重復(fù)代碼；體現(xiàn)系統(tǒng)中的全部設(shè)計理念；包括盡量少的實(shí)體，比如類、方法、函數(shù)等。,10,如何編寫整潔代碼,命名函數(shù)注釋類,11,命名,一、要“名副其實(shí)”a、這件事情要嚴(yán)肅對待。在起一個表意的名字上花時間是值得的，優(yōu)秀程序員從細(xì)節(jié)做起。b、如果名稱需要注釋來補(bǔ)充，那就不是“名副其實(shí)”。Demo：intd;/消逝的時間，以天計算應(yīng)該使用指明計量對象和計量單位的名稱。IntelapsedTimeInDays;IntdaysSinceCreation;IntdaysSinceModificatin;IntfileAgeInDays,12,命名,c、問題不在于代碼的簡潔度，而在于代碼的“模糊度”。這里的意思是簡短的代碼，如果不能表達(dá)含義，也是不能做到“名副其實(shí)”。Demo:Java:pulicListgetThem()Listlist1=newArrayList();For(intx:theList)If(x0=4)list1.add(x);returnlist1;這里的代碼夠簡單了，但是沒人知道theList是什么東西、theList0的意思是什么、d、是什么意義、以及返回list1該怎么用。這就是作者所說的“模糊度”，因?yàn)橐饬x比較模糊，所以這些代碼也不“名副其實(shí)”。那么怎么呢？應(yīng)該根據(jù)這段代碼的意圖來修改這里的函數(shù)名，變量名，值的含義（用常量）。,13,命名,二、命名要避免誤導(dǎo)程序員必須避免留下掩藏代碼本意的錯誤線索。Demo:accountList這個名字就不太好，因?yàn)閘ist這詞在java中是一個類型，如果這個名字表達(dá)的類型或者含義不是list就不應(yīng)該這樣命名。,14,命名,三、做有意義的區(qū)分a、不要用數(shù)字命名，Demo:a1,a2,a3。b、話是另一種沒有意義的區(qū)分，Demo：如有有一個類叫Product類，那么ProductInfo與ProctductData就是沒有意義的區(qū)分，因?yàn)樗鼈兒x幾乎一樣。c、使用讀得出來的名字d、使用搜索得出來的名字e、接口和實(shí)現(xiàn)Demo:IShapeFactory和SharpFactory之間，選擇后者作為接口名,15,函數(shù),函數(shù)的第一條規(guī)則是要短小，第二條規(guī)則還是要短小。40年的經(jīng)驗(yàn)告訴作者，函數(shù)就是要短小。20行封頂最佳。每個函數(shù)都一目了然，每個函數(shù)都做一件事。而且每個函數(shù)都依序把你帶到下一個函數(shù)，這就是函數(shù)應(yīng)該達(dá)到的短小程度。,16,函數(shù),二、只做一件事函數(shù)所做的事情都在一個抽象層級，叫“只做一件事”。如果各個層級抽象混雜在一起，顯然就做了不止一件事了,17,函數(shù),三、每個函數(shù)一個抽象層級函數(shù)中混雜不同的抽象層級，往往讓人迷惑。讀者無法判斷哪些是基礎(chǔ)概念哪些是細(xì)節(jié)。讀者無法提綱挈領(lǐng)的代價是，它無法快速學(xué)習(xí)，快速理解。從而為更多的bug埋下隱患。,18,函數(shù),四、使用描述性名稱Demo:testtableHtmlSetupTeardownIncluder.render。如果長一點(diǎn)的名稱可以更加清晰，不要猶豫，用清晰的吧。,19,函數(shù),五、函數(shù)參數(shù)最好是0，其次是1，再次是2，避免3個及以上的參數(shù)個數(shù)。參數(shù)過多會使得客戶程序員上手的代價加大，優(yōu)秀代碼的可能性降低。,20,函數(shù),五、抽離Try/Catch代碼將try/catch代碼隔離出來，避免影響主程序邏輯。Demo:TryDeletePage(page);/DeletePage是一個方法Catch(Exceptione)LogError(e);/LogError是一個方法錯誤處理就是一件事。,21,注釋,什么也比不上放置良好的注釋來的有用。什么也比不上亂七八糟的注釋更有本事搞亂一個模塊。什么也不會比陳舊、提供錯誤信息的注釋更有破壞性。注釋并不像辛德勒的名單。他們并不“純?nèi)坏暮谩?。?shí)際上，注釋最多也就是一個必須的惡，也編程語言足夠有表達(dá)力，或者我們長于用這些語言來表達(dá)意圖，就不那么需要注釋也許根本不需要。,22,注釋,一、注釋會撒謊。a、這個比較令人費(fèi)解。但是它真實(shí)的存在于我們的系統(tǒng)中，并且是大量的存在。原因很簡單，程序員不能堅(jiān)持維持注釋，程序存在的時間越久，注釋的可信度、可讀程序就很低。作者認(rèn)為，程序員雖然有保持注釋精讀的責(zé)任，但是更應(yīng)該做的是整理代碼，減少注釋，注釋過多往往是一種程序“腐化的壞味道”。b、注釋不能美化糟糕的代碼。,23,注釋,二、好的注釋a、不可省略的涉及到法律的信息b、提供信息的注釋:如果找不到好名字，則用注釋提供信息是好的做法c、對意圖進(jìn)行解釋:對某些可以選擇的實(shí)現(xiàn)決定進(jìn)行解釋d、闡釋:將一些晦澀難明的參數(shù)或者返回值的意義編譯為更加可讀的形式e、警示:這里指的是一些特定行為的代碼的注釋。比如某個測試可能會運(yùn)行很長時間之類的注釋。f、TODO注釋:未完成的列表。完成后要刪除掉。g、放大:放大、明示某些特殊用法的合理性。,24,注釋,三、壞的注釋a、喃喃自語這種情況大量存在，屬于程序員的只說自話，基本是垃圾代碼的借口或者錯誤決策的修正。b、多余的注釋大量存在，沒有什么意義的廢話注釋。c、誤導(dǎo)性注釋不夠精確或者干脆寫錯了d、循規(guī)試注釋指的是應(yīng)文檔化工具的需求就添加的本來不需要注釋的注釋。,25,注釋,e、日志試注釋指的是本代碼文件的修改歷史類，將每天的修改記錄寫上，這完全沒有必要，可以被現(xiàn)代源碼管理工具取代。它影響了代碼閱讀。f、可怕的廢話注釋g、能用函數(shù)或者變量的時候就不用注釋h、位域標(biāo)記這類注釋用于標(biāo)記一個特別的位置。這種用法應(yīng)該在特定的情況下使用，但是多數(shù)屬于不必要的濫用。i、括號后的注釋這里指的是代碼太長了，在后添加注釋表示代碼段結(jié)束。這類注釋一般是程序需要整理的標(biāo)志。,26,注釋,j、歸屬于署名現(xiàn)在源碼管理可以取代，基本不需要了。k、注釋掉的代碼L、HTML注釋令人討厭。m、非本地信息n、信息過多o、不明顯的聯(lián)系,27,類,一、類的組織公共靜