最近在看《編寫可讀代碼的藝術(shù)》到涂,在這里記錄一下點(diǎn)點(diǎn)滴滴
代碼應(yīng)當(dāng)易于理解##
可讀性基本定律:代碼的寫法應(yīng)當(dāng)使被人理解它所需的時(shí)間最小化府蛇,但并不是越小越好判帮,要注意理解代碼所需的時(shí)間是否與其他目標(biāo)有沖突
第一部分:表面層次的改進(jìn)###
- 選擇好的名字
- 寫好的注釋
- 把代碼整潔的寫成更好的格式
選擇好的名字(名稱語義化)
- 選擇專業(yè)的詞 (不使用Get,使用Fetch或者Download等更專業(yè)的詞)
- 避免泛泛的名字(例如temp)
- 用具體的名字代替抽象的名字
- 使用前綴或后綴來給名字附帶更多信息
- 決定名字的長(zhǎng)度(小的作用域使用短的名字轨奄,丟掉沒有用的詞ConvertToString簡(jiǎn)介為ToString)
- 利用名字的格式來表達(dá)含義(例如大寫代表常量min和max等)
代碼整潔的寫成更好的格式(提高審美)
- 使用一致的布局,讓讀者很快就習(xí)慣這種風(fēng)格
- 讓相似的代碼看上去相似
- 把相關(guān)的代碼行分組敲才,形成代碼塊
提高代碼審美的技巧
- 重新安排換行來保持一致和緊湊
- 用方法來整理不規(guī)則的東西
- 在需要時(shí)使用列對(duì)齊
- 選一個(gè)有意義的順序始終一致的使用它
- 把聲明按塊組織起來(比如方法和變量聲明應(yīng)該自成一塊)
- 個(gè)人風(fēng)格的一致性(一致的風(fēng)格比“正確”的風(fēng)格更重要)
該寫什么樣的注釋(注釋物有所值)
- 不要為了注釋而注釋
- 不要給不好的名字加注釋(先把名字改好)
- 記錄你的思想
- 加入導(dǎo)演評(píng)論(自己的見解)
- 為代碼中的瑕疵寫注釋(同時(shí)可以寫一些要做的事)
- 給常量加注釋
- 站在讀者角度
- 公布可能的陷阱
- 全局觀注釋(團(tuán)隊(duì)的新成員快速熟悉代碼)
- 總結(jié)性注釋
- 克服作者心理阻滯
寫出言簡(jiǎn)意賅的注釋(注釋應(yīng)當(dāng)有很高的信息)
- 讓注釋保持緊湊
- 避免使用不明確的代詞
- 潤色粗糙的句子
- 精確的描述函數(shù)(方法)的行為
- 聲明代碼的意圖
- 采用信息含量高的詞