繼續(xù)讀《代碼整潔之道》挥唠。
注釋
- 認(rèn)為寫注釋就表示一種失敗，因?yàn)槟愕拇a讓人不明白焕议，才需要注釋宝磨，某種程度上來(lái)說(shuō)也不無(wú)道理。
- 代碼會(huì)有修改盅安，但注釋卻不一定及時(shí)維護(hù)唤锉，時(shí)間越長(zhǎng)，注釋和實(shí)際情況的差別就可能越大别瞭。
- 通過(guò)一個(gè)與注釋意義相同的函數(shù)來(lái)代替注釋窿祥，比如
不如改成// Check to see if the employee is eligible for full benefits if ((employee.flags & HOURLY_FLAG) && (employee.age > 65))if (employee.isEligibleForFullBenefits()) - 作者也列出一些需要用注釋的情況，不過(guò)原則還是盡量用代碼本身去表明準(zhǔn)確的意圖蝙寨。如果要寫晒衩，注釋要精確，一定要真有用墙歪，如果根本就不需要看這注釋听系，就不要為了添加注釋而加注釋
- “直接把代碼注釋掉是令人討厭的做法”，實(shí)際項(xiàng)目中虹菲，我倒是經(jīng)常會(huì)這么干靠胜，因?yàn)轫?xiàng)目經(jīng)常會(huì)有調(diào)整，有時(shí)候這樣做，有時(shí)候那樣做浪漠，所以不想將舊的刪除窄锅，因?yàn)楹竺孢€會(huì)用到。通過(guò)版本管理工具去看舊代碼僵腺，理論是這樣呵晚，雖然 Git 能看到過(guò)去的代碼，但是真想用必盖，那么多提交歷史拌牲，要一個(gè)一個(gè)看，是哪次修改動(dòng)的這塊代碼歌粥，實(shí)在浪費(fèi)時(shí)間塌忽。
- 注釋里寫 html 標(biāo)簽令人討厭，我也這么認(rèn)為失驶。
格式
- 短文件比長(zhǎng)文件更易于理解土居。確實(shí)是這樣，一個(gè)文件行數(shù)太多嬉探，方法太多擦耀，跳轉(zhuǎn)來(lái)跳轉(zhuǎn)去的都麻煩。
- 關(guān)系密切的函數(shù)放在一起涩堤，只能盡量眷蜓，有時(shí)可能一個(gè)函數(shù)和多個(gè)函數(shù)有關(guān)系，那應(yīng)該把它們放一起了胎围，結(jié)果其中一個(gè)函數(shù)又和另外的有關(guān)系吁系，所以看另外一個(gè)函數(shù)的邏輯時(shí)，又得跨越多于一屏的去看
- “源文件最頂部應(yīng)該給出高層次概念和算法白魂。細(xì)節(jié)應(yīng)該往下漸次展開汽纤，直至找到源文件中最底層的函數(shù)和細(xì)節(jié)「］”
- 全局變量的聲明都放到頂部去蕴坪。大部分情況是如此，只是有時(shí)開發(fā)過(guò)程中逞姿，加一個(gè)變量辞嗡，會(huì)懶得滑到文件頂部，直接在當(dāng)前位置聲明了變量滞造，這個(gè)還是要改正续室。
- 代碼行字符不要太多，要短小谒养，千萬(wàn)不要到需要橫向拖動(dòng)才能看全的地步挺狰。
- 字符與符號(hào)間的空格明郭，縮進(jìn)，換行之類丰泊，已經(jīng)屬于常識(shí)了薯定。
