代碼整潔之道-格式
- 2019 年 10 月 6 日
- 筆記
對於代碼的格式,每個人都有不同的代碼風格,這沒什麼。但是對於一個團隊來說,最好能夠統一代碼風格,在同一個項目中,如果到處充斥着不同的代碼風格,相比讀起來並不是那麼讓人舒適,比如在什麼地方放置括號,縮進幾個字符,如何命名常量、變量和方法等,整個團隊都應該遵循同一套規則,甚至可以將這些規則編寫到IDE的代碼格式中,利用IDE的提示功能來幫助。
剛才說的風格隨不同,但是並不會影響讀者閱讀。但是有些代碼風格讓人難以閱讀,而有些則會讓讀者心曠神怡。那麼怎樣的格式能夠讓人愉悅的閱讀呢?簡單的總結幾條,可以看看是否會幫助閱讀,若是,請這樣做。
- 在每個方法前加空行,起強調作用
- 局部變量的生命盡量靠近其使用的位置
- 類變量應在類的頂部聲明
- 若某個函數調用了另一個函數,應該將調用者放到被調用這的上面,這樣有一個自然閱讀的順序
- 執行相似操作的一組函數應該放在一起
- 每行代碼不應過長,至少不能超出屏幕閱讀的寬度
- 代碼的縮進,不用解釋,閱讀縮進不規範的代碼是在令人痛苦
- 如果循環語句的循環體為空,也要確保空循環體的縮進,否則很容易將後一句看做循環體
- 等等