好的格式讓人感到代碼的整潔,一致及所感知到的對細節的關注而震驚。保持良好的代碼格式,選用一套管理代碼格式的簡單規則,然後貫徹這些規則。
格式的目的:
代碼格式關乎溝通,增加代碼的可讀性垂直格式
關係密切的概念應相互靠近。
變量聲明 變量聲明應儘可能靠近其使用位置
實體變量 應該在類的頂部聲明
相關函數 某個函數調用了另一個函數,將他們放一起,調用者應儘可能在被調者的上方向報紙學習 名稱應該簡單且一目瞭然。內容短小精悍
概念間垂直方向上的區隔
從上往下,從左往右,每一行一個表達式,每組代碼展示一條完整的思路,這些思路用空白行區隔開來垂直方向上的靠近
擁有緊密關係的代碼行應相互靠近。垂直距離
函數之間會調用,如果函數距離相隔甚遠,你沒有辦法去理解函數關係,系統的功能。
關係密切的概念應該相互靠近。他們之間的區隔應該成爲對相互的易懂度有多重要的衡量標準。應避免迫使讀者在源文件和類中跳來跳去。
6.1 變量聲明 應儘可能靠近其使用位置;短小函數 本地變量應在函數頂部出現
6.2 實體變量 應在類的頂部聲明。
6.3 相關函數 函數A調用了函數B,應將他們放在一起,A在B的前面
6.4 概念相關 概念相關的代碼應該放在一起。相關性越強,彼此之間的距離就該越短。垂直順序 被調用的函數應該放在執行調用的函數下面
橫向格式
一行代碼應該多寬。一行代碼太長閱讀起來不如人意,太短造成句意感覺上的分割。上限應在80左右(120)。水平方向上的區隔與靠近 空格的使用
乘除運算項不加空格,加減之間加空格,以體現優先級水平對齊 不用讓變量的修飾符、類型、名稱上下對齊,不易閱讀
縮進 即使短小的if、while或小函數也應縮進。
空範圍 當while、for語句沒有方法體時,也應用{}表示。易於閱讀
團隊規則
開發團隊應具有同樣的編碼風格