代碼規範

http://www.jianshu.com/p/8b76814b3663

Objective-C 規範指南

大體遵循 NYTimes 標準，

原文以下（https://github.com/NYTimes/objective-c-style-guide）

介紹

關於這個編程語言的全部規範，若是這裏沒有寫到，那就在蘋果的文檔裏：

Objective-C 編程語言
Cocoa 基本原理指南
Cocoa 編碼指南
iOS 應用編程指南
目錄

點語法
間距
條件判斷
三目運算符
錯誤處理
方法
變量
命名
註釋
Init 和 Dealloc
字面量
CGRect 函數
常量
枚舉類型
位掩碼
私有屬性
圖片命名
布爾
單例
Xcode 工程
點語法

應該 始終 使用點語法來訪問或者修改屬性，訪問其餘實例時首選括號。

推薦：

view.backgroundColor = [UIColor orangeColor];
[UIApplication sharedApplication].delegate;
反對：

[view setBackgroundColor:[UIColor orangeColor]];
UIApplication.sharedApplication.delegate;
間距

一個縮進使用 4 個空格，永遠不要使用製表符（tab）縮進。請確保在 Xcode 中設置了此偏好。
方法的大括號和其餘的大括號（if/else/switch/while 等等）始終和聲明在同一行開始，在新的一行結束。
推薦：

if (user.isHappy) {
// Do something
}
else {
// Do something else
}
方法之間應該正好空一行，這有助於視覺清晰度和代碼組織性。在方法中的功能塊之間應該使用空白分開，但每每可能應該建立一個新的方法。
@synthesize 和 @dynamic 在實現中每一個都應該佔一個新行。
條件判斷

條件判斷主體部分應該始終使用大括號括住來防止出錯，即便它能夠不用大括號（例如它只須要一行）。這些錯誤包括添加第二行（代碼）並但願它是 if 語句的一部分時。還有另一種更危險的，當 if 語句裏面的一行被註釋掉，下一行就會在不經意間成爲了這個 if 語句的一部分。此外，這種風格也更符合全部其餘的條件判斷，所以也更容易檢查。

推薦：

if (!error) {
    return success;
}
反對：

if (!error)
    return success;
或

if (!error) return success;
三目運算符

三目運算符，? ，只有當它能夠增長代碼清晰度或整潔時才使用。單一的條件都應該優先考慮使用。多條件時一般使用 if 語句會更易懂，或者重構爲實例變量。

推薦：

result = a > b ? x : y;
反對：

result = a > b ? x = c > d ? c : d : y;
錯誤處理

當引用一個返回錯誤參數（error parameter）的方法時，應該針對返回值，而非錯誤變量。

推薦：

NSError *error;
if (![self trySomethingWithError:&error]) {
    // 處理錯誤
}
反對：

NSError *error;
[self trySomethingWithError:&error];
if (error) {
    // 處理錯誤
}
一些蘋果的 API 在成功的狀況下會寫一些垃圾值給錯誤參數（若是非空），因此針對錯誤變量可能會形成虛假結果（以及接下來的崩潰）。

方法

在方法簽名中，在 -/+ 符號後應該有一個空格。方法片斷之間也應該有一個空格。

推薦：

- (void)setExampleText:(NSString *)text image:(UIImage *)image;
變量

變量名應該儘量命名爲描述性的。除了 for() 循環外，其餘狀況都應該避免使用單字母的變量名。 星號表示指針屬於變量，例如：NSString *text 不要寫成 NSString* text 或者 NSString * text ，常量除外。 儘可能定義屬性來代替直接使用實例變量。除了初始化方法（init， initWithCoder:，等）， dealloc 方法和自定義的 setters 和 getters 內部，應避免直接訪問實例變量。更多有關在初始化方法和 dealloc 方法中使用訪問器方法的信息，參見這裏。

推薦：

@interface NYTSection: NSObject

@property (nonatomic) NSString *headline;

@end
反對：

@interface NYTSection : NSObject {
    NSString *headline;
}
變量限定符

當涉及到在 ARC 中被引入變量限定符時， 限定符 (__strong, __weak, __unsafe_unretained, __autoreleasing) 應該位於星號和變量名之間，如：NSString * __weak text。

命名

儘量遵照蘋果的命名約定，尤爲那些涉及到內存管理規則，（NARC）的。

長的和描述性的方法名和變量名都不錯。

推薦：

UIButton *settingsButton;
反對：

UIButton *setBut;
類名和常量應該始終使用三個字母的前綴（例如 NYT），但 Core Data 實體名稱能夠省略。爲了代碼清晰，常量應該使用相關類的名字做爲前綴並使用駝峯命名法。

推薦：

static const NSTimeInterval NYTArticleViewControllerNavigationFadeAnimationDuration = 0.3;
反對：

static const NSTimeInterval fadetime = 1.7;
屬性和局部變量應該使用駝峯命名法而且首字母小寫。

爲了保持一致，實例變量應該使用駝峯命名法命名，而且首字母小寫，如下劃線爲前綴。這與 LLVM 自動合成的實例變量相一致。 若是 LLVM 能夠自動合成變量，那就讓它自動合成。

推薦：

@synthesize descriptiveVariableName = _descriptiveVariableName;
反對：

id varnm;
註釋

當須要的時候，註釋應該被用來解釋 爲何 特定代碼作了某些事情。所使用的任何註釋必須保持最新不然就刪除掉。

一般應該避免一大塊註釋，代碼就應該儘可能做爲自身的文檔，只須要隔幾行寫幾句說明。這並不適用於那些用來生成文檔的註釋。

init 和 dealloc

dealloc 方法應該放在實現文件的最上面，而且恰好在 @synthesize 和 @dynamic 語句的後面。在任何類中，init都應該直接放在 dealloc 方法的下面。

init 方法的結構應該像這樣：

- (instancetype)init {
    self = [super init]; // 或者調用指定的初始化方法
    if (self) {
        // Custom initialization
    }

    return self;
}
字面量

每當建立 NSString， NSDictionary， NSArray，和 NSNumber 類的不可變實例時，都應該使用字面量。要注意 nil 值不能傳給 NSArray 和 NSDictionary 字面量，這樣作會致使崩潰。

推薦：

NSArray *names = @[@"Brian", @"Matt", @"Chris", @"Alex", @"Steve", @"Paul"];
NSDictionary *productManagers = @{@"iPhone" : @"Kate", @"iPad" : @"Kamal", @"Mobile Web" : @"Bill"};
NSNumber *shouldUseLiterals = @YES;
NSNumber *buildingZIPCode = @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 *buildingZIPCode = [NSNumber numberWithInteger:10018];
CGRect 函數

當訪問一個 CGRect 的 x， y， width， height 時，應該使用CGGeometry 函數代替直接訪問結構體成員。蘋果的 CGGeometry 參考中說到：

All functions described in this reference that take CGRect data structures as inputs implicitly standardize those rectangles before calculating their results. For this reason, your applications should avoid directly reading and writing the data stored in the CGRect data structure.  Instead, use the functions described here to manipulate rectangles and to retrieve their characteristics.

推薦：

CGRect frame = self.view.frame;

CGFloat x = CGRectGetMinX(frame);
CGFloat y = CGRectGetMinY(frame);
CGFloat width = CGRectGetWidth(frame);
CGFloat height = CGRectGetHeight(frame);
反對：

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;
常量

常量首選內聯字符串字面量或數字，由於常量能夠輕易重用而且能夠快速改變而不須要查找和替換。常量應該聲明爲 static 常量而不是 #define ，除非很是明確地要當作宏來使用。

推薦：

static NSString * const NYTAboutViewControllerCompanyName = @"The New York Times Company";

static const CGFloat NYTImageThumbnailHeight = 50.0;
反對：

#define CompanyName @"The New York Times Company"

#define thumbnailHeight 2
枚舉類型

當使用 enum 時，建議使用新的基礎類型規範，由於它具備更強的類型檢查和代碼補全功能。如今 SDK 包含了一個宏來鼓勵使用使用新的基礎類型 - NS_ENUM()

推薦：

typedef NS_ENUM(NSInteger, NYTAdRequestState) {
    NYTAdRequestStateInactive,
    NYTAdRequestStateLoading
};
位掩碼

當用到位掩碼時，使用 NS_OPTIONS 宏。

舉例：

typedef NS_OPTIONS(NSUInteger, NYTAdCategory) {
NYTAdCategoryAutos      = 1 << 0,
NYTAdCategoryJobs       = 1 << 1,
NYTAdCategoryRealState  = 1 << 2,
NYTAdCategoryTechnology = 1 << 3
};
私有屬性

私有屬性應該聲明在類實現文件的延展（匿名的類目）中。有名字的類目（例如 NYTPrivate 或 private）永遠都不該該使用，除非要擴展其餘類。

推薦：

@interface NYTAdvertisement ()

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

@end
圖片命名

圖片名稱應該被統一命名以保持組織的完整。它們應該被命名爲一個說明它們用途的駝峯式字符串，其次是自定義類或屬性的無前綴名字（若是有的話），而後進一步說明顏色 和/或 展現位置，最後是它們的狀態。

推薦：

RefreshBarButtonItem / RefreshBarButtonItem@2x 和 RefreshBarButtonItemSelected / RefreshBarButtonItemSelected@2x
ArticleNavigationBarWhite / ArticleNavigationBarWhite@2x 和 ArticleNavigationBarBlackSelected / ArticleNavigationBarBlackSelected@2x.
圖片目錄中被用於相似目的的圖片應納入各自的組中。

布爾

由於 nil 解析爲 NO，因此沒有必要在條件中與它進行比較。永遠不要直接和 YES 進行比較，由於 YES 被定義爲 1，而 BOOL 能夠多達 8 位。

這使得整個文件有更多的一致性和更大的視覺清晰度。

推薦：

if (!someObject) {
}
反對：

if (someObject == nil) {
}
對於 BOOL 來講, 這有兩種用法:

if (isAwesome)
if (![someObject boolValue])
反對：

if ([someObject boolValue] == NO)
if (isAwesome == YES) // 永遠別這麼作
若是一個 BOOL 屬性名稱是一個形容詞，屬性能夠省略 「is」 前綴，但爲 get 訪問器指定一個慣用的名字，例如：

@property (assign, getter=isEditable) BOOL editable;
內容和例子來自 Cocoa 命名指南 。

單例

單例對象應該使用線程安全的模式建立共享的實例。

+ (instancetype)sharedInstance {
   static id sharedInstance = nil;

   static dispatch_once_t onceToken;
   dispatch_once(&onceToken, ^{
      sharedInstance = [[self alloc] init];
   });

   return sharedInstance;
}
這將會預防有時可能產生的許多崩潰。

Xcode 工程

爲了不文件雜亂，物理文件應該保持和 Xcode 項目文件同步。Xcode 建立的任何組（group）都必須在文件系統有相應的映射。爲了更清晰，代碼不只應該按照類型進行分組，也能夠根據功能進行分組。

若是能夠的話，儘量一直打開 target Build Settings 中 "Treat Warnings as Errors" 以及一些額外的警告。若是你須要忽略指定的警告,使用 Clang 的編譯特性 。