
作者:乞力馬扎羅的雪(GitHub) 原文见此
開發過程中,我們不仅要讀別人的程式碼,也要讓別人讀我們的程式碼。因此,養成良好的編碼習慣非常重要。以下列出使用 Objective-C 開發 iOS 的一些編碼建議。
【1】任何函數長度不得超過 50 行。(其實很容易就超過,這時就該考慮程式碼抽取了。)
【2】任何一行程式碼不能超過 80 字元。(同樣容易超,可以考慮多行顯示,例如有多個參數時每個參數各放一行。)可以在 Xcode 中開啟超過 80 字元的提醒:選中 “Page guide at column”,設定後程式碼第 80 字元處會出現一條垂直線。

【3】每個方法定義前空一行,也就是方法與方法之間留一行空白。
【4】功能相近的方法放在一起,並建議用 #pragma mark - *** 導航程式碼、切分程式碼塊,方便函數查找。搭配快捷鍵 control+6 可以快速跳轉到方法位置。
【5】二元運算符與運算元之間要有一個空格,例如賦值號 = 左右各留一個空格。
self.myString = @"235423rew523452345";
【6】一元運算符與運算元之間不空格,例如 !(非)、&(按位與)、|(按位或)。
BOOL isOpen = true; BOOL isClose = !isOpen;
【7】強制類型轉換與運算元之間不空格。
NSString *str3 = (NSString *)self.myString;
【8】較長的變量值應拆分為多行,這在宣告陣列或字典時尤其明顯。以下同時示範了快速宣告陣列 @[] 與字典 @{} 的寫法。
NSArray *array = @[@"111",
@"2222222222",
@"3333333",
@"wwwwwwwwwwww"];NSDictionary *dict = @{
@"name": @"Tom",
@"age": @"20",
@"gender": @"female",
@"isMarried": @"false"
};【9】盡量使用有意義的名稱,拒絕用 i、j 這類無意義字元命名。類名首字母大寫,其他變量首字母小寫,並使用駝峰式分隔單詞。
【10】盡量減少程式碼中直接出現數字常量,改用宏定義等方式,例如用 MAX_NUMBER_PHONE 取代 8,搜尋時也方便。
【11】盡量減少重複計算。例如多處都要用螢幕寬度,每次都寫 [[UIScreen mainScreen] bounds].size.width 顯得冗長,不如直接宏定義:
#define SCREEN_WIDTH ([[UIScreen mainScreen] bounds].size.width)
【12】合理使用約定俗成的縮略詞:
alloc:分配;alt:輪流、交替;app:應用程序;calc:計算
dealloc:銷毀、析構;func:函數、方法;horiz:水平的;info:資訊
init:初始化;max:最大的;min:最小的;msg:消息
nib:Interface Builder;rect:矩形;temp:暫時的;vert:垂直的
【13】宏定義全部大寫。
【14】函數長度不要超過 50 行,小函數的可讀性優於大函數。函數參數不宜過多:零元函數最好,一元函數也不錯,超過三元就該考慮重構。
【15】合理範圍內使用鏈式編程:
NSString *myName = [[NSString alloc] init];
但嵌套不宜超過三層,超過就需重構。
【16】函數呼叫時所有參數寫在同一行;參數過多則每行一個,並以冒號對齊。
【17】對傳入參數做保護或空值判斷時,盡量不要用 if (!obj),改用 NSAssert 斷言。NSAssert 是系統定義的宏:
NSAssert(myName != nil, @"myName 參數為空");
條件為真時,程式繼續執行;
條件為假時,拋出異常,異常內容即後面定義的字串。
【18】方法參數名前一般用 “an”、“the”、“new” 修飾,例如:
- (void)setPersonInfo:(NSString *)theID theName:(NSString *)theName theAge:(NSInteger *)theAge
【19】if-else 超過四層時就該考慮重構,多層 if-else 極難維護。
【20】當需要滿足條件才執行某項操作時,最左邊的應該是最重要的程式碼,不要把它內嵌進 if 裡。良好的風格是:
- (void)someMethod {
if (![someOther boolValue]) {
return;
}
// 最重要的程式碼寫在這裡
}反面教材:
- (void)someMethod {
if ([someOther boolValue]) {
// 重要程式碼
}
}【21】所有邏輯塊都用 {} 包圍,哪怕只有一行程式碼。
【22】明確指定構造函數,並加上適當註釋。
【23】不要在 init 方法中把變量或屬性初始化為 0 或 nil,沒有必要。
【24】UIView 的子類在初始化時不要做任何佈局操作。佈局應在 layoutSubviews 裡做;需要重新佈局時呼叫 setNeedsLayout,而不要直接呼叫 layoutSubviews。
【25】保持公共 API 簡單,也就是保持 .h 檔簡單。寫進 .h 的方法都是公開的,如果根本沒必要讓其他類知道,就不要宣告在 .h 中。
【26】一個檔案只實作一個類,同一檔案中不要有多個類。
【27】Protocol 單獨用一個檔案建立,盡量不要與相關類混在同一檔案。
【28】類定義中用到自己定義的類時,盡量不要在頭檔中引入對方的頭檔,改用 @class 前向宣告,並在實作檔案中引入。
【29】佈局時盡量使用相對佈局,例如以子 View 在父 View 中的相對位置為依據。
【30】程式碼折疊。這條關於開發效率,但很有用,所以也寫進來。Xcode 7 預設沒有開啟程式碼折疊,方法體很長時看起來很不方便,此時就可以把方法「收起來」,讓類的結構一目了然。開啟方式:Xcode 選單 → Preferences → Text Editing → 勾選 Code folding ribbon。

【31】建議方法的第一個大括號直接跟在方法簽名後,而不是另起一行,可減少程式碼行數。
【32】建議方法體第一行留空、最後一行不留空,這樣方法邊界更清晰。

不過,若該括號內又是一個 if、for 這類帶括號的語句塊,第一行可以不空;若括號內第一行是註釋,也可以不空(註釋本身就起到了分隔作用);若括號內只有一行程式碼,同樣可以不空。
【33】block 的第一行也要留空,理由同方法體,讓程式碼更清晰。
【34】代表類方法與實例方法的 +、- 之後需要一個空格。這是個很小的細節,但系統內建方法都是這樣寫的,我們自己宣告或實作方法時也應遵循。

【35】這條比較像編程經驗:為了解決某個問題要學會估算時間。要開發某功能、調試某個 bug,給自己一個時間上限,若期限內解決不了就去求助。這既是給自己壓力,也避免浪費時間。老實說這條很難做到,我常常因為不甘心而無限拖延。
【36】提到編程經驗,就不得不提版本控制。務必學會 SVN 或 Git,即使你是獨立開發,也要學會控制自己的程式碼——當然,還要經常備份。
以上都是我的一家之言。如果你的團隊或公司有自己的編碼規範,當然以團隊的為準。