《從零開始學Swift》學習筆記(Day 59)——程式碼排版

智捷關東昇發表於2016-04-06

原創文章,歡迎轉載。轉載請註明:關東昇的部落格

  程式碼排版包括: 空行、空格、斷行和縮排等內容。程式碼排版內容比較多工作量很多,但是非常重要。  
空行  
  空行將邏輯相關的程式碼段分隔開,以提高可讀性。下列情況應該總是新增空行:  

  • 型別宣告之前。
  • 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個空格),再往後的斷行要與第一次的斷行對齊。

歡迎關注關東昇新浪微博@tony_關東昇。 關注智捷課堂微信公共平臺,瞭解最新技術文章、圖書、教程資訊

enter image description here

更多精品iOS、Cocos、移動設計課程請關注智捷課堂官方網站:http://www.zhijieketang.com 智捷課堂論壇網站:http://51work6.com/forum.php

相關文章