iOS開發Objective-C編碼規範

iOS開發Objective-C編碼規範

摘要：由於每個人的Objective-C編碼風格都不一致，這樣不易於保持代碼一致性和難以Code Review。為了保證項目代碼的優雅、一致和易讀性，所以，每個參與此項目的開發人員都需要盡量支援統一的Objective-C編碼風格指南。以下作為此項目的編碼規範，如有更好的規範，可以陸續最佳化。

一、_ 語言 _

應該使用US英語

二、_ 程式碼群組織 _

在函數分組和protocol/delegate實現中使用#pragma mark -來分類方法，要遵循以下一般結構：

 #prama mark - Lifecycle #prama mark -- (void)ViewDidLoad{}- (void)viewWillAppear:(BOOL)animated {}  #pragma mark - Custom Accessors #pragma mark -- (void)setCustomProperty:(id)value {}  - (id)customProperty {}   #pragma mark - Public #pragma mark - - (void)publicMethod {}   #pragma mark - Private #pragma mark - - (void)privateMethod {} 

三、_ 空格 _

縮排使用4個空格，確保在Xcode喜好設定來設定

方法大括弧和其他大括弧(if/else/switch/while 等.)總是在可以同一行語句開啟 或是新一行語句開啟但在新行中關閉

個人喜好為新一行語句開啟和新行中關閉，如下所示

if (user.isHappy)  {    //Do something  }  else {    //Do something else  } 

四、_ 注釋 _

注釋很重要，但除了開頭的著作權聲明，儘可能把代碼寫的如同文檔一樣，讓別人直接看代碼就知道意思，寫代碼時別擔心名字太長，相信Xcode的提示功能。

執行個體變數應該在實現檔案.m中聲明或以@property形式在.h檔案中聲明，一定要直接在.h檔案聲明，加上@priavte，另外，使用@private、@public，前面需要一個縮排空格。

儘可能保證 .h檔案的簡潔性，可以不公開的API就不要公開了，寫在實現檔案中即可。

屬性注釋：

@property (nonatomic,assign) NSInteger xLineCount;  /**< 格子橫線數量 */

只需要這樣注釋，在設定其屬性時候，可以清晰瞭解到當前屬性對應的注釋資訊
如果每次都手動寫類似格式，可以Xcode自訂代碼模組，設定當前的代碼塊為/*< <#注釋描述#> /

方法注釋：

/*! *  @brief 用一組資料初始化直條圖 * *  @param frame 初始化frame *  @param data  設定當前的圖表百分比 * *  @return 對象本身 */- (instancetype)initWithFrame:(CGRect)frame dictionary:(NSDictionary *)data;

Tips：有很多可以自動產生注釋格式的外掛程式，推薦使用 VVDocumenter

五、_ 命名 _

iOS聲明屬性或方法等需要遵循駝峰式命名規則

類名首字母大寫，方法首字母小寫，方法中的參數首字母小寫，同時盡量讓方法的命名讀起來是一句話，能夠傳達出方法的意思，同時取值方法前不要加首碼get 或 set(和內建set或get混淆)，變數名小寫字母開頭，常量以小寫字母k開頭，後續首字母大寫

聲明類或方法時，注意空格的使用，參數過多時可換行保持對齊，調用方法時也是如此，參數都寫在一行或換行冒號對齊

常量應該使用駝峰式命名規則，所有的單字首大寫和加上與類名有關的首碼。

六、_ 底線 _

當使用屬性時，執行個體變數應該使用self.來訪問和改變。這就意味著所有屬性將會視覺效果不同，因為它們前面都有self.。

但有一個特例：在初始化方法裡，執行個體變數(例如，_variableName)應該直接被使用來避免getters/setters潛在的副作用。

局部變數不應該包含底線。

七、_ 方法 _

在方法簽名中，應該在方法類型(-/+ 符號)之後有一個空格。在方法各個段之間應該也有一個空格(符合Apple的風格)。在參數之前應該包含一個具有描述性的關鍵字來描述參數。

“and”這個詞的用法應該保留。它不應該用於多個參數來說明，就像initWithWidth:height以下這個例子：
例如：

- (void)setExampleText:(NSString *)text image:(UIImage *)image; - (void)sendAction:(SEL)aSelector to:(id)anObject forAllCells:(BOOL)flag;- (id)viewWithTag:(NSInteger)tag;- (instancetype)initWithWidth:(CGFloat)width height:(CGFloat)height;

八、_ 變數 _

變數盡量以描述性的方式來命名。單個字元的變數命名應該盡量避免，除了在for()迴圈。

星號表示變數是指標。例如， NSString text 既不是 NSString text 也不是 NSString * text_，除了一些特殊情況下常量。

九、_ 屬性特性 _

所有屬性特性應該顯式地列出來，有助於新手閱讀代碼。屬性特性的順序應該是storage、atomicity，與在Interface Builder串連UI元素時自動產生代碼一致。

@property (weak, nonatomic) IBOutlet UIView *containerView;

@property (strong, nonatomic) NSString *tutorialName;

十、_ 點符號文法 _

點文法是一種很方便封裝存取方法調用的方式。當你使用點文法時，通過使用getter或setter方法，屬性仍然被訪問或修改。

點文法應該 _ 總是 _ 被用來訪問和修改屬性，因為它使代碼更加簡潔。[]符號更偏向於用在其他例子。

十一、_ 字面值 _

NSString、NSDictionary、NSArray和NSNumber的字面值應該在建立這些類的不可變執行個體時被使用。請特別注意nil值不能傳入NSArray和NSDictionary字面值，因為這樣會導致crash。

應該：

NSArray *names = @[@"Brian", @"Matt", @"Chris", @"Alex", @"Steve", @"Paul"];  NSDictionary *productManagers = @{@"iPhone": @"Kate", @"iPad": @"Kamal", @"Mobile Web": @"Bill"};  NSNumber *shouldUseLiterals = @YES;  NSNumber *buildingStreetNumber = @10018;  

不應該:

NSArray *names = [NSArray arrayWithObjects:@"Brian", @"Matt", @"Chris", @"Alex", @"Steve", @"Paul", nil];  NSDictionary *productManagers = [NSDictionary dictionaryWithObjectsAndKeys: @"Kate", @"iPhone", @"Kamal", @"iPad", @"Bill", @"Mobile Web", nil]; NSNumber *shouldUseLiterals = [NSNumber numberWithBool:YES];  NSNumber *buildingStreetNumber = [NSNumber numberWithInteger:10018];

十二、 常量

常量是容易重複被使用和無需通過尋找和代替就能快速修改值。常量應該使用static來聲明而不是使用#define，除非顯式地使用宏。

應該：

static NSString * const RWTAboutViewControllerCompanyName = @"RayWenderlich.com";  static CGFloat const RWTImageThumbnailHeight = 50.0;  

不應該：

 #define CompanyName @"RayWenderlich.com"   #define thumbnailHeight 2  

十三、 枚舉類型

當使用enum時，推薦使用新的固定基本類型規格，因為它有更強的類型檢查和代碼補全。現在SDK有一個宏NS_ENUM()來協助和鼓勵你使用固定的基本類型。

例如：

typedef NS_ENUM(NSInteger, RWTLeftMenuTopItemType) {    RWTLeftMenuTopItemMain,    RWTLeftMenuTopItemShows,    RWTLeftMenuTopItemSchedule  }; 

你也可以顯式地賦值(展示舊的k-style常量定義)：

typedef NS_ENUM(NSInteger, RWTGlobalConstants) {    RWTPinSizeMin = 1,    RWTPinSizeMax = 5,    RWTPinCountMin = 100,    RWTPinCountMax = 500,  }; 

舊的k-style常量定義應該避免除非編寫Core Foundation C的代碼。

不應該：

enum GlobalConstants {    kMaxPinSize = 5,    kMaxPinCount = 500,  };  

十四、 Case語句

大括弧在case語句中並不是必須的，除非編譯器強制要求。當一個case語句包含多行代碼時，大括弧應該加上。

switch (condition) {    case 1:      // ...      break;    case 2: {      // ...      // Multi-line example using braces      break;    }    case 3:      // ...      break;    default:       // ...      break;  }  

有很多次，當相同代碼被多個cases使用時，一個fall-through應該被使用。一個fall-through就是在case最後移除’break’語句，這樣就能夠允許執行流程跳轉到下一個case值。為了代碼更加清晰，一個fall-through需要注釋一下。

switch (condition) {    case 1:      // ** fall-through! **    case 2:      // code executed for values 1 and 2      break;    default:       // ...      break;  }  

當在switch使用枚舉類型時，’default’是不需要的。例如：

RWTLeftMenuTopItemType menuType = RWTLeftMenuTopItemMain;  switch (menuType) {    case RWTLeftMenuTopItemMain:      // ...      break;    case RWTLeftMenuTopItemShows:      // ...      break;    case RWTLeftMenuTopItemSchedule:      // ...      break;  }  

十五、 私人屬性

私人屬性應該在類的實現檔案中的類擴充(匿名分類)中聲明，命名分類(比如RWTPrivate或private)應該從不使用除非是擴充其他類。匿名分類應該通過使用+Private.h檔案的命名規則暴露給測試。

例如：

@interface RWTDetailViewController ()  @property (strong, nonatomic) GADBannerView *googleAdView;  @property (strong, nonatomic) ADBannerView *iAdView;  @property (strong, nonatomic) UIWebView *adXWebView;  @end 

十六、_ 布爾值 _

Objective-C使用YES和NO。因為true和false應該只在CoreFoundation，C或C++代碼使用。既然nil解析成NO，所以沒有必要在條件陳述式比較。不要拿某樣東西直接與YES比較，因為YES被定義為1和一個BOOL能被設定為8位。

這是為了在不同檔案保持一致性和在視覺上更加簡潔而考慮。

應該：

if (someObject) {}  if (![anotherObject boolValue]) {}  

不應該：

if (someObject == nil) {}  if ([anotherObject boolValue] == NO) {}  if (isAwesome == YES) {} // Never do this.  if (isAwesome == true) {} // Never do this.  

如果BOOL屬性的名字是一個形容詞，屬性就能忽略”is”首碼，但要指定get訪問器的慣用名稱。例如：

@property (assign, getter=isEditable) BOOL editable;  

十七、_ 條件陳述式 _

條件陳述式主體為了防止出錯應該使用大括弧包圍，即使條件陳述式主體能夠不用大括弧編寫(如，只用一行代碼)。這些錯誤包括添加第二行代碼和期望它成為if語句；還有，even more dangerous defect可能發生在if語句裡面一行代碼被注釋了，然後下一行代碼不知不覺地成為if語句的一部分。除此之外，這種風格與其他條件陳述式的風格保持一致，所以更加容易閱讀。

應該：

if (!error) {    return success;  }  

不應該：

if (!error)    return success;  

或

if (!error) return success;  

十八、_ 三元操作符 _

當需要提高代碼的清晰性和簡潔性時，三元操作符?:才會使用。單個條件求值常常需要它。多個條件求值時，如果使用if語句或重構成執行個體變數時，代碼會更加易讀。一般來說，最好使用三元操作符是在根據條件來賦值的情況下。

Non-boolean的變數與某東西比較，加上括弧()會提高可讀性。如果被比較的變數是boolean類型，那麼就不需要括弧。

應該：

NSInteger value = 5;  result = (value != 0) ? x : y;  BOOL isHorizontal = YES;  result = isHorizontal ? x : y;  

不應該：

result = a > b ? x = c > d ? c : d : y;  

十九、_ Init方法 _

Init方法應該遵循Apple產生代碼模板的命名規則，傳回型別應該使用instancetype而不是id。

- (instancetype)init {    self = [super init];    if (self) {      // ...    }    return self;  }  

二十、_ 類構造方法 _

當類構造方法被使用時，它應該傳回型別是instancetype而不是id。這樣確保編譯器正確地推斷結果類型。

@interface Airplane  + (instancetype)airplaneWithType:(RWTAirplaneType)type;  @end  

二十一、_ CGRect函數 _

當訪問CGRect裡的x, y, width, 或 height時，應該使用CGGeometry函數而不是直接通過結構體來訪問。引用Apple的CGGeometry：

在這個參考文檔中所有的函數，接受CGRect結構體作為輸入，在計算它們結果時隱式地標準化這些rectangles。因此，你的應用程式應該避免直接存取和修改儲存在CGRect資料結構中的資料。相反，使用這些函數來操縱rectangles和擷取它們的特性。
應該：

CGRect frame = self.view.frame;  CGFloat x = CGRectGetMinX(frame);  CGFloat y = CGRectGetMinY(frame);  CGFloat width = CGRectGetWidth(frame);  CGFloat height = CGRectGetHeight(frame);  CGRect frame = CGRectMake(0.0, 0.0, width, height);  

不應該：

CGRect frame = self.view.frame;  CGFloat x = frame.origin.x;  CGFloat y = frame.origin.y;  CGFloat width = frame.size.width;  CGFloat height = frame.size.height;  CGRect frame = (CGRect){ .origin = CGPointZero, .size = frame.size };  

二十二、_ 黃金路徑 _

當使用條件陳述式編碼時，左手邊的代碼應該是”golden” 或 “happy”路徑。也就是不要嵌套if語句，多個返回語句也是OK。

應該：

- (void)someMethod {    if (![someOther boolValue]) {      return;    }    //Do something important  }  

不應該：

- (void)someMethod {    if ([someOther boolValue]) {      //Do something important    }  }  

二十三、_ 錯誤處理 _

當方法通過引用來返回一個錯誤參數，判斷傳回值而不是錯誤變數。

應該：

NSError *error;  if (![self trySomethingWithError:&error]) {    // Handle Error  }  

不應該：

NSError *error;  [self trySomethingWithError:&error];  if (error) {    // Handle Error  }  

在成功的情況下，有些Apple的APIs記錄垃圾值(garbage values)到錯誤參數(如果non-NULL)，那麼判斷錯誤值會導致false負值和crash。

二十四、_ 單例模式 _

單例對象應該使用安全執行緒模式來建立共用執行個體。

+ (instancetype)sharedInstance {    static id sharedInstance = nil;    static dispatch_once_t onceToken;    dispatch_once(&onceToken, ^{      sharedInstance = [[self alloc] init];    });    return sharedInstance;  }  

這會防止possible and sometimes prolific crashes。

二十五、_ 分行符號 _

分行符號是一個很重要的主題，因為它的風格指南主要為了列印和網上的可讀性。

例如：

self.productsRequest = [[SKProductsRequest alloc] initWithProductIdentifiers:productIdentifiers];  

一行很長的代碼應該分成兩行代碼，下一行用兩個空格隔開。

self.productsRequest = [[SKProductsRequest alloc]     initWithProductIdentifiers:productIdentifiers]; 

二十六、_ Xcode工程 _

物理檔案應該與Xcode工程檔案保持同步來避免檔案擴張。任何Xcode分組的建立應該在檔案系統的檔案體現。代碼不僅是根據類型來分組，而且還可以根據功能來分組，這樣代碼更加清晰。