眾觀而言,程式碼是否好閱讀,編排、排版佔了相當大的份量。此篇列舉一些項目,提供各位參考。
變數宣告應該?
- x
一律集中在最上方
個人認為這應該是 C 語言留下來的習慣,現在多數的程式語言都沒有這樣的限制,應以容易閱讀為主。 - o
盡可能靠近使用處
Function 與被呼叫的子 Function 應如何排列?
- o
由上而下
如同閱讀文章一般,由上而下,先看到大架構。有需要再往下看細節。 - x
由下而上
這應該也是 C 語言留下來的習慣。
一行應該在多少字元以下?
100 以下為佳,不超過 120 。
此圖為書中某 JAVA 專案的單行字元數分佈狀況:
一個檔案應該小於幾行?
200 以下為佳,不超過 500。倘若超過,該思考該 Class 是否做了太多事情,應再抽離出新的 Class?
此圖為書中提到的幾個 JAVA 專案檔案行數的分佈狀況:
※ 文中白底截圖均為「無瑕的程式碼」書中圖片。