您现在的位置: IOS教程網 >> IOS系統 >  >> iOS 程式開發 >> iOS 開發綜合

iOS 代碼規範:命名、排版與專案約定

編輯:iOS 開發綜合

命名規則對維護程式碼至關重要。Objective-C 的方法名往往很長,但這反而是優點——名字本身就是最好的註解,很多註釋因此可以省下來。

一、命名規範

1. 駝峰命名法

Objective-C 社群的標準。小駝峰:除第一個單字外,其餘單字首字母大寫,通常用於變數;大駝峰:連第一個單字的首字母也大写,通常用於類別名稱。

2. 基本原則

清晰優先:既清晰又簡潔最好,但兩者衝突時,簡潔必須讓步。盡量不要使用單字縮寫(nav、bg、btn 這類已成為共識的除外),API 名稱不能有歧義,一看就知道做了什麼事。

一致性:同一件事在所有地方都叫同一個名字。既然 tag、setStringValue 是慣例,你就該沿用;真的想不到好名字時,參考系統 API 的取名方式通常不會錯。

禁止中文與拼音:識別字一律使用英文。

3. 類別命名

類名(不含 Category 與 Protocol)使用大駝峰,並應包含一個或多個名詞來說明這個類別的職責。應用層級的程式碼盡量不加前綴,因為每個類都帶同樣前綴並不會提升可讀性;但若撰寫跨應用共用的程式碼,前綴就是必要且推薦的做法(例如 MWPhotoBrowser)。

4. Category 命名

格式為「類名 + 標識 + 擴展」,例如 UIImageView + HP + Web。Category 的方法也應該加上前綴(如 hp_myCategoryMethodOnAString),以避免 Objective-C 單一命名空間下的方法衝突。若程式碼不打算對外共享,這條規則可以放寬。

5. 方法命名

使用小駝峰。一個好的方法名讀起來應該像一句完整的話,讀完就知道它做什麼。執行型方法以動詞開頭並用小寫字母起首;回傳型方法則以回傳的內容開頭,而且前面不要加 get。

6. 變數命名

  1. 使用小駝峰,名字要具描述性,讓人推測得出用途。別為了少打幾個字母而犧牲可讀性。
  2. 特定類型要帶上類型後綴:陣列用 xxxArray 或 xxxList,字典用 xxxDictionary,尺寸用 xxxSize。反之,把 NSArray 命名成 xxxDictionary 是嚴重錯誤。
  3. UI 控件變數後綴須為控件名,如 @property (weak, nonatomic) IBOutlet UILabel *versionLabel;
  4. 控制器後綴必須是 ViewController,名字太長時至少也要以 Controller 結尾。
  5. 普通 View 後綴必須是 View;UITableViewCell、UICollectionViewCell 後綴必須是 Cell。
  6. 成員變數盡量用 @property 宣告;若不這麼做,則必須以底線前綴宣告。

7. 常量命名

  1. 常量前面加 k 作為標記:static const NSTimeInterval kAnimationDuration = 0.3;
  2. 作為字典 Key 或通知名稱的字串要加 const 防止被改,通知名稱一律以 Notification 結尾,例如 NSString *const UIApplicationDidEnterBackgroundNotification;
  3. 避免在程式碼中直接寫死常量,出現次數較多的值應抽成 const 常量統一管理。

8. 枚舉命名

枚舉型別名稱加上相關類名前綴,枚舉值則加上型別前綴:

typedef NS_ENUM(NSInteger, UIViewAnimationTransition) {
    UIViewAnimationTransitionNone,
    UIViewAnimationTransitionFlipFromLeft,
    UIViewAnimationTransitionFlipFromRight,
    UIViewAnimationTransitionCurlUp,
    UIViewAnimationTransitionCurlDown,
};

9. 圖片資源命名

原則有兩條:使用單字全拼或公認無歧義的縮寫(nav、bg、btn 等);採用「模組 + 功能」的命名法。模組分為公共與私有兩類——公共模組包含統一背景、導覽列、標籤、通用按鈕、預設圖等;私有模組則依 App 的業務劃分,如用戶中心、消息中心。

Assets.xcassets 中的資料夾必須分模組、命名一律小寫,且圖片要先命名好再放進去。一般至少會有 common、tabbar、navigation 三個模組。

公共模組範例:背景圖以 bg 結尾,按鈕背景以 btn 結尾。

  • nav_bar_bg@2x.png
  • nav_back@2x.png
  • tabbar_record_normal@2x.png、tabbar_record_selected@2x.png
  • common_cell_placeholder@2x.png

私有模組範例(以用戶中心為例):

  • mine_avatar_bg@2x.png
  • mine_top_defaut_bg@2x.png

10. 目錄命名

英文命名時首字母大寫;可用中文,但禁止拼音。

二、編碼排版格式

  1. 縮進使用空格而非 Tab,單位為 2 個字元。快速格式化:Command + A 之後 Control + I。
  2. 左右大括弧各自單獨占一行。
  3. 每行只寫一個語句。

空格使用要點

  • 關鍵字與其後的運算式之間要有空格。
  • 單目運算子不與運算元分開(如 !、^)。
  • 除逗號外,其他雙目運算子與運算元之間要用空格隔開。
  • .h 中,協定角括弧前留一個空格。
  • .h 中成員宣告時,類型與變數間至少一個空格,星號靠近變數而非類型。
  • @property 後留一個空格;括號內逗號緊跟前一變數、與後一變數間留一個空格;括號外先留一個空格再宣告屬性。
  • 方法的 +、- 與括號之間留一個空格。
  • 回傳類型與星號之間留一個空格,方法參數中的回傳類型與星號之間同樣留一個空格。
  • 多參數方法中,每個參數後面都有一個空格。

空行規則

.h 檔:檔案說明與 import 之間空 1 行;import 之間若需分類則各類間空 1 行;import 與 @class 之間空 2 行;@interface 與 @class 之間空 1 行;大括弧內外分別空 1 行開始宣告成員與屬性;屬性下方空 1 行寫方法;方法結束後空 1 行再寫 @end;若需宣告 protocol,空 2 行接著寫,通常 protocol 宣告在 @interface 之前、定義在 @end 之後。

.m 檔:檔案說明與 import 間空 1 行;import 分類之間空 1 行;@implementation 與 @synthesize 間空 1 行;方法與方法之間空 1 行。

方法內部:變數宣告後空 1 行;條件、迴圈、選擇語句整段結束後空 1 行;各功能塊之間空 1 行;最後一個括弧前不空行;註釋與程式碼之間不空行;#pragma mark 與方法之間空 1 行。

每行程式碼不得超過 100 字元,設定方式:Xcode → Preferences → Text Editing → Page Guide at column 輸入 100。

註釋

變數名、方法名不足以說明實際意義時必須寫註釋;類名不足以體現類別職責時,必須在宣告上方補充說明。需要註釋的地方主要包括類註釋、方法註釋、成員變數註釋、枚舉註釋、巨集定義與巨集方法註釋、邏輯註釋、Protocol 註釋。推薦使用 VVDocumenter 這類外掛自動生成模板。

其他硬性要求

所有新建目錄在工程下必須存在實體目錄;單頁面程式碼不得超過 800 行,單個方法不得超過 50 行。

三、規定

  1. dealloc 若有存在必要,必須是 .m 中的最後一個方法,方便查找。
  2. 非特殊需要,不允許把 UI 控件的 property 直接寫在 .h 中。
  3. 需要條件才執行某操作時,最重要的程式碼應該放在最外層,而不是被埋在 if 裡面。

良好風格:

- (void) someMethod {
    if(![someOther boolValue]) {
        return;
    }
    //最重要的代碼寫在這裡;
}

反面範例:

- (void) someMethod {
    if([someOther boolValue]) {
        //重要代碼被埋在裡面;
    }
}

四、建議

  1. 盡量不用 for 迴圈,改用 for-in 或 enumerateObjectsUsingBlock 遍歷。
  2. 盡可能保持 .h 的簡潔,不該公開的 API 就寫在實作檔裡。
  3. 善用 #pragma mark 分區,方便閱讀;暫時無解的問題用 #pragma warning 標記提醒。
  4. if-else 嵌套超過四層就該考慮重構,多層嵌套極難維護。
  5. UITableViewCell、UIView 子類在初始化時不要做任何布局,布局應放在 layoutSubviews 中;需要重新布局時呼叫 setNeedsLayout,不要直接呼叫 layoutSubviews。
  6. 方法的第一個左括弧直接跟在方法簽名後面,可減少行數。
  7. 方法體第一行留空、最後一行不留空,視覺層次會更清楚;但若該括弧內第一行是註釋、或整塊只有一行程式碼,則第一行可不留空。
  1. 上一篇文章:
  2. 下一篇文章:
蘋果刷機越獄教程| IOS教程問題解答| IOS技巧綜合| IOS7技巧| IOS8教程
Copyright © IOS教程網 All Rights Reserved