Objective-C編碼規(guī)范

[TOC]

語(yǔ)言

應(yīng)該使用英語(yǔ).盡量少使用拼音，但alibab、taobao、youku、shenzhen等國(guó)際通用的名稱，可視同英文.

應(yīng)該:

UIColor *myColor = [UIColor whiteColor];

不應(yīng)該:

UIColor *myColour = [UIColor whiteColor];

編碼規(guī)范

• 所有的方法之間空一行。
• 所有的代碼塊之間空一行，刪除多余的注釋。
• 所有自定義的方法需要給出注釋。
• 盡量使用懶加載，在控制器分類時(shí)有提及和要求，其它自定義類按照控制器格式分類，沒有的分類不寫即可。
  代碼后的’{‘不需要獨(dú)占一行，包括方法之后，if，switch等。
• 必須要統(tǒng)一的要求，屬性的定義請(qǐng)按照下圖property之后，空一格，括號(hào)之后空一格，寫上類名，空一格之后跟上*和屬性名。

@property (nonatomic, strong) UITableView *tableView;///< 注釋
@property (nonatomic, strong) DeliveryModel *delivery;///< 注釋
@property (nonatomic, strong) DeliveryLookAdapter *lookAdapter;///< 注釋
@property (nonatomic, strong) DeliveryLookAPIManager *lookManager;///< 注釋

• 遵循一般代碼規(guī)范，多模仿蘋果API。
• 刪除不用的代碼。
• 如果有方法一直不會(huì)用到，請(qǐng)刪除（除工具類）。
• 沒有執(zhí)行任何業(yè)務(wù)邏輯的方法，請(qǐng)刪除或給予注釋，刪除多余的資。源或文件，添加必要的注釋。
• 比較大的代碼塊需要給出注釋。

代碼組織

在函數(shù)分組和protocol/delegate實(shí)現(xiàn)中使用#pragma mark -來(lái)分類方法，要遵循以下一般結(jié)構(gòu)：

#pragma mark - Lifecycle
- (instancetype)init {}
- (void)dealloc {}
- (void)viewDidLoad {}
- (void)viewWillAppear:(BOOL)animated {}
- (void)didReceiveMemoryWarning {}

#pragma mark - Custom Accessors
- (void)setCustomProperty:(id)value {}
- (id)customProperty {}

#pragma mark - IBActions/Event Response
- (IBAction)submitData:(id)sender {}
- (void)someButtonDidPressed:(UIButton*)button

#pragma mark - Protocol conformance
#pragma mark - UITextFieldDelegate
#pragma mark - UITableViewDataSource
#pragma mark - UITableViewDelegate

#pragma mark - Public
- (void)publicMethod {}

#pragma mark - Private
- (void)privateMethod {}

#pragma mark - NSCopying
- (id)copyWithZone:(NSZone *)zone {}

#pragma mark - NSObject
- (NSString *)description {}

空格

• 縮進(jìn)使用4個(gè)空格，確保在Xcode偏好設(shè)置來(lái)設(shè)置。(raywenderlich.com使用2個(gè)空格)
• 方法大括號(hào)和其他大括號(hào)(if/else/switch/while 等.)總是在同一行語(yǔ)句打開但在新行中關(guān)閉。

應(yīng)該:

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

不應(yīng)該:

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

• 在方法之間應(yīng)該有且只有一行，這樣有利于在視覺上更清晰和更易于組織。在方法內(nèi)的空白應(yīng)該分離功能，但通常都抽離出來(lái)成為一個(gè)新方法。
• 優(yōu)先使用auto-synthesis。但如果有必要，@synthesize 和 @dynamic應(yīng)該在實(shí)現(xiàn)中每個(gè)都聲明新的一行。

注釋

當(dāng)需要注釋時(shí)，注釋應(yīng)該用來(lái)解釋這段特殊代碼為什么要這樣做。任何被使用的注釋都必須保持最新或被刪除。

一般都避免使用塊注釋，因?yàn)榇a盡可能做到自解釋，只有當(dāng)斷斷續(xù)續(xù)或幾行代碼時(shí)才需要注釋。例外：這不應(yīng)用在生成文檔的注釋

屬性注釋

@property (nonatomic,copy) NSString *descriptiveVariableName; ///< 注釋

類注釋

//
//  MyViewController.m
//  這個(gè)類是做什么的
//
//  Created by  xxx on 2017/9/12.
//  Copyright ? 2017年 miku. All rights reserved.
//

方法注釋

在復(fù)雜方法，或者無(wú)法通過(guò)方法名自解釋下需要添加方法注釋

/**
 測(cè)試
 */
- (void)text
{
    //測(cè)試按鈕事件響應(yīng)
}

命名

Apple命名規(guī)則盡可能堅(jiān)持，特別是與這些相關(guān)的memory management rules (NARC)。

長(zhǎng)的，描述性的方法和變量命名是好的。

應(yīng)該:

UIButton *settingsButton;

不應(yīng)該:

UIButton *setBut;

三個(gè)字符前綴應(yīng)該經(jīng)常用在類和常量命名，但在Core Data的實(shí)體名中應(yīng)被忽略。對(duì)于官方的raywenderlich.com書、初學(xué)者工具包或教程，前綴'RWT'應(yīng)該被使用。

常量應(yīng)該使用駝峰式命名規(guī)則，所有的單詞首字母大寫和加上與類名有關(guān)的前綴。

應(yīng)該:

static NSTimeInterval const RWTTutorialViewControllerNavigationFadeAnimationDuration = 0.3;

不應(yīng)該:

static NSTimeInterval const fadetime = 1.7;

屬性也是使用駝峰式，但首單詞的首字母小寫。對(duì)屬性使用auto-synthesis，而不是手動(dòng)編寫@ synthesize語(yǔ)句，除非你有一個(gè)好的理由。

應(yīng)該:

@property (nonatomic,copy) NSString *descriptiveVariableName;

不應(yīng)該:

id varnm;

類命名

類的命名都遵循大駝峰命名。一般是：前綴 + 功能 + 類型。例如：SMK + Login + Controller。SMKLoginController

在實(shí)際開發(fā)中，一般都會(huì)給工程中所有的類加上屬于本工程的前綴。

資源文件命名

全部小寫，采用下劃線命名法，加前綴區(qū)分。
命名模式：可加后綴small表示小圖,big表示大圖，邏輯名稱可由多個(gè)單詞加下劃線組成，采用以下規(guī)則：
用途模塊名邏輯名稱 btn_mine_login
用途模塊名顏色 bg_mine_green
用途邏輯名稱 nav_bar_back
用途顏色 icon_gray

下劃線

當(dāng)使用屬性時(shí)，實(shí)例變量應(yīng)該使用self.來(lái)訪問(wèn)和改變。這就意味著所有屬性將會(huì)視覺效果不同，因?yàn)樗鼈兦懊娑加?code>self.。

但有一個(gè)特例：在初始化方法里，實(shí)例變量(例如，_variableName)應(yīng)該直接被使用來(lái)避免getters/setters潛在的副作用。

局部變量不應(yīng)該包含下劃線。

方法

在方法簽名中，應(yīng)該在方法類型(-/+ 符號(hào))之后有一個(gè)空格。在方法各個(gè)段之間應(yīng)該也有一個(gè)空格(符合Apple的風(fēng)格)。在參數(shù)之前應(yīng)該包含一個(gè)具有描述性的關(guān)鍵字來(lái)描述參數(shù)。

"and"這個(gè)詞的用法應(yīng)該保留。它不應(yīng)該用于多個(gè)參數(shù)來(lái)說(shuō)明，就像initWithWidth:height以下這個(gè)例子：

應(yīng)該:

- (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;

不應(yīng)該:

-(void)setT:(NSString *)text i:(UIImage *)image;
- (void)sendAction:(SEL)aSelector :(id)anObject :(BOOL)flag;
- (id)taggedView:(NSInteger)tag;
- (instancetype)initWithWidth:(CGFloat)width andHeight:(CGFloat)height;
- (instancetype)initWith:(int)width and:(int)height;  // Never do this.

變量

變量盡量以描述性的方式來(lái)命名。單個(gè)字符的變量命名應(yīng)該盡量避免，除了在for()循環(huán)。

星號(hào)表示變量是指針。例如， NSString *text 既不是 NSString* text 也不是 NSString * text，除了一些特殊情況下常量。

私有變量 應(yīng)該盡可能代替實(shí)例變量的使用。盡管使用實(shí)例變量是一種有效的方式，但更偏向于使用屬性來(lái)保持代碼一致性。

通過(guò)使用'back'屬性(_variable，變量名前面有下劃線)直接訪問(wèn)實(shí)例變量應(yīng)該盡量避免，除了在初始化方法(init, initWithCoder:, 等…)，dealloc 方法和自定義的setters和getters。想了解關(guān)于如何在初始化方法和dealloc直接使用Accessor方法的更多信息，查看這里

應(yīng)該:

@interface RWTTutorial : NSObject

@property (nonatomic, copy) NSString *tutorialName;

@end

不應(yīng)該:

@interface RWTTutorial : NSObject {
  NSString *tutorialName;
}

屬性特性

所有屬性特性應(yīng)該顯式地列出來(lái)，有助于閱讀代碼。

NSString應(yīng)該使用copy 而不是 strong的屬性特性。

為什么？即使你聲明一個(gè)NSString的屬性，有人可能傳入一個(gè)NSMutableString的實(shí)例，然后在你沒有注意的情況下修改它。

應(yīng)該:

@property (nonatomic,copy) NSString *tutorialName;

不應(yīng)該:

@property (nonatomic,strong) NSString *tutorialName;

點(diǎn)符號(hào)語(yǔ)法

點(diǎn)語(yǔ)法是一種很方便封裝訪問(wèn)方法調(diào)用的方式。當(dāng)你使用點(diǎn)語(yǔ)法時(shí)，通過(guò)使用getter或setter方法，屬性仍然被訪問(wèn)或修改。想了解更多，閱讀這里

點(diǎn)語(yǔ)法應(yīng)該總是被用來(lái)訪問(wèn)和修改屬性，因?yàn)樗勾a更加簡(jiǎn)潔。[]符號(hào)更偏向于用在其他例子。

應(yīng)該:

NSInteger arrayCount = [self.array count];
view.backgroundColor = [UIColor orangeColor];
[UIApplication sharedApplication].delegate;

不應(yīng)該:

NSInteger arrayCount = self.array.count;
[view setBackgroundColor:[UIColor orangeColor]];
UIApplication.sharedApplication.delegate;

字面值

NSString, NSDictionary, NSArray, 和 NSNumber的字面值應(yīng)該在創(chuàng)建這些類的不可變實(shí)例時(shí)被使用。請(qǐng)?zhí)貏e注意nil值不能傳入NSArray和NSDictionary字面值，因?yàn)檫@樣會(huì)導(dǎo)致crash。

應(yīng)該:

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

不應(yīng)該:

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];

<b id="constants"></b>

常量

常量是容易重復(fù)被使用和無(wú)需通過(guò)查找和代替就能快速修改值。常量應(yīng)該使用static來(lái)聲明而不是使用#define，除非顯式地使用宏。

應(yīng)該:

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

static CGFloat const RWTImageThumbnailHeight = 50.0;

不應(yīng)該:

#define CompanyName @"RayWenderlich.com"

#define thumbnailHeight 2

枚舉類型

當(dāng)使用enum時(shí)，推薦使用新的固定基本類型規(guī)格，因?yàn)樗懈鼜?qiáng)的類型檢查和代碼補(bǔ)全?，F(xiàn)在SDK有一個(gè)宏NS_ENUM()來(lái)幫助和鼓勵(lì)你使用固定的基本類型。

例如:

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常量定義應(yīng)該避免除非編寫Core Foundation C的代碼。

不應(yīng)該:

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

<b id="case-statements"></b>

Case語(yǔ)句

大括號(hào)在case語(yǔ)句中并不是必須的，除非編譯器強(qiáng)制要求。當(dāng)一個(gè)case語(yǔ)句包含多行代碼時(shí)，大括號(hào)應(yīng)該加上。

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

有很多次，當(dāng)相同代碼被多個(gè)cases使用時(shí)，一個(gè)fall-through應(yīng)該被使用。一個(gè)fall-through就是在case最后移除'break'語(yǔ)句，這樣就能夠允許執(zhí)行流程跳轉(zhuǎn)到下一個(gè)case值。為了代碼更加清晰，一個(gè)fall-through需要注釋一下。

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

當(dāng)在switch使用枚舉類型時(shí)，'default'是不需要的。例如：

RWTLeftMenuTopItemType menuType = RWTLeftMenuTopItemMain;

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

私有屬性

私有屬性應(yīng)該在類的實(shí)現(xiàn)文件中的類擴(kuò)展(匿名分類)中聲明，命名分類(比如RWTPrivate或private)應(yīng)該從不使用除非是擴(kuò)展其他類。匿名分類應(yīng)該通過(guò)使用<headerfile>+Private.h文件的命名規(guī)則暴露給測(cè)試。

例如:

@interface RWTDetailViewController ()

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

@end

布爾值

Objective-C使用YES和NO。因?yàn)?code>true和false應(yīng)該只在CoreFoundation，C或C++代碼使用。既然nil解析成NO，所以沒有必要在條件語(yǔ)句比較。不要拿某樣?xùn)|西直接與YES比較，因?yàn)?code>YES被定義為1和一個(gè)BOOL能被設(shè)置為8位。

這是為了在不同文件保持一致性和在視覺上更加簡(jiǎn)潔而考慮。

應(yīng)該:

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

不應(yīng)該:

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

如果BOOL屬性的名字是一個(gè)形容詞，屬性就能忽略"is"前綴，但要指定get訪問(wèn)器的慣用名稱。例如：

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

文字和例子從這里引用Cocoa Naming Guidelines

條件語(yǔ)句

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

應(yīng)該:

if (!error) {
  return success;
}

不應(yīng)該:

if (!error)
  return success;

或

if (!error) return success;

三元操作符

當(dāng)需要提高代碼的清晰性和簡(jiǎn)潔性時(shí)，三元操作符?:才會(huì)使用。單個(gè)條件求值常常需要它。多個(gè)條件求值時(shí)，如果使用if語(yǔ)句或重構(gòu)成實(shí)例變量時(shí)，代碼會(huì)更加易讀。一般來(lái)說(shuō)，最好使用三元操作符是在根據(jù)條件來(lái)賦值的情況下。

Non-boolean的變量與某東西比較，加上括號(hào)()會(huì)提高可讀性。如果被比較的變量是boolean類型，那么就不需要括號(hào)。

應(yīng)該:

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

BOOL isHorizontal = YES;
result = isHorizontal ? x : y;

不應(yīng)該:

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

Init方法

Init方法應(yīng)該遵循Apple生成代碼模板的命名規(guī)則。返回類型應(yīng)該使用instancetype而不是id

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

查看關(guān)于instancetype的文章Class Constructor Methods

類構(gòu)造方法

當(dāng)類構(gòu)造方法被使用時(shí)，它應(yīng)該返回類型是instancetype而不是id。這樣確保編譯器正確地推斷結(jié)果類型。

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

關(guān)于更多instancetype信息，請(qǐng)查看NSHipster.com

黃金路徑

當(dāng)使用條件語(yǔ)句編碼時(shí)，不要嵌套太多if語(yǔ)句，多個(gè)返回語(yǔ)句也是OK。

應(yīng)該:

- (void)someMethod {
  if (![someOther boolValue]) {
    return;
  }

  //Do something important
}

不應(yīng)該:

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

錯(cuò)誤處理

當(dāng)方法通過(guò)引用來(lái)返回一個(gè)錯(cuò)誤參數(shù)，判斷返回值而不是錯(cuò)誤變量。

應(yīng)該:

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

不應(yīng)該:

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

在成功的情況下，有些Apple的APIs記錄垃圾值(garbage values)到錯(cuò)誤參數(shù)(如果non-NULL)，那么判斷錯(cuò)誤值會(huì)導(dǎo)致false負(fù)值和crash。

單例模式

單例對(duì)象應(yīng)該使用線程安全模式來(lái)創(chuàng)建共享實(shí)例。

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

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

  return sharedInstance;
}

這會(huì)防止possible and sometimes prolific crashes.

換行符

換行符是一個(gè)很重要的主題，因?yàn)樗娘L(fēng)格指南主要為了打印和網(wǎng)上的可讀性。

例如:

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

一行很長(zhǎng)的代碼應(yīng)該分成兩行代碼，下一行用兩個(gè)空格隔開。

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

github-raywenderlich.com