代碼排版包括空行、空格、斷行和縮進等內容。排版內容看似瑣碎、工作量不小,卻至關重要。
空行
空行能把邏輯相關的代碼段分隔開,以提高可讀性。下列情況應該總是添加空行:
類型聲明之前。
import 語句前後。
兩個方法或函數之間。
塊注釋或單行注釋之前。
方法或函數內的兩個邏輯段之間,用以提高可讀性。
一個源文件的兩個片段之間。
空格
代碼中有些位置是需要空格的,這塊工作量也很大。下面是使用空格的規範:
1. 賦值符號 “=” 前後各有一個空格;var 或 let 與標識符之間有一個空格。所有二元運算符都應該用空格與操作數分開;一元操作符與操作數之間則不應加空格,如 ++、-- 等。示例如下。
var a = 10 var c = 10 a += c + d
2. 小左括號 “(” 之後、小右括號 “)” 之前不要有空格。示例如下。
a = (a + b) / (c * d)
3. 大左括號 “{” 之前有一個空格。示例如下。
while a == d { n++ }
4. 在方法或函數參數之間有一個空格,參數冒號與數據類型之間有一個空格。
推薦使用:
func tableView(tableView:UITableView, didSelectRowAtIndexPath indexPath:NSIndexPath) { ... }
不推薦使用:
func tableView(tableView:UITableView,didSelectRowAtIndexPath indexPath:NSIndexPath) { ... }
斷行
一行代碼的長度盡量避免超過 80 個字符。為了便於查看一行是否超出 80 字符,很多 IDE 都可以在編輯窗口設置顯示 80 豎線。在 Xcode 中的設置過程是:打開菜單 Xcode→Preferences,選擇 Text Editing 標簽,選中 Show→Page guide at column。
由於有些代碼比較長需要斷行,可以依據如下一般規範斷開:
在一個逗號後面斷開。
在一個操作符前面斷開,要選擇較高級別的運算符斷開,而非較低級別的運算符斷開。
新的一行應該與上一行縮進兩個級別(8 個空格)。
縮進
4 個空格常被作為縮進排版的一個單位。開發時使用制表符進行縮進,雖然默認情況下一個制表符等於 8 個空格,但在不同 IDE 工具中,一個制表符與空格的對應個數可能有所不同。Xcode 默認是一個制表符對應 4 個空格,我們可以在 Xcode 中打開菜單 Xcode→Preferences,選擇 Text Editing→Indentation 標簽,在 Tab width 中進行設置。
縮進可以依據如下一般規範:
在函數、方法、閉包、控制語句、計算屬性等包含大括號 “{}” 的代碼塊中,代碼塊內容與首行縮進一個級(4 個空格)。
如果是 if 語句中條件表達式的斷行,那麼新的一行應該與上一行縮進兩個級別(8 個空格),再往後的斷行要與第一次的斷行對齊。