iOS代碼規(guī)范總結(jié)

一些原則

1. 長的，描述性的方法和變量命名是好的。不要使用簡寫，除非是一些大家都知道的場景比如 VIP。如 bgView、reqURL、videoBtn，修改為 backgroundView、videoButton
2. 方法名長沒問題，但含義清楚，做好不加注釋代碼自我表述能力強(qiáng)。（前提是代碼足夠規(guī)范） 如下方wkWebView官方api：

- (nullable WKNavigation *)loadFileURL:(NSURL *)URL allowingReadAccessToURL:(NSURL *)readAccessURL API_AVAILABLE(macos(10.11), ios(9.0));

3. 不要過分追求技巧，降低代碼可讀性。
4. 刪除沒必要的代碼，可通過git等追溯找回，沒必要保留。
5. 在方法內(nèi)部不要重復(fù)計算某個值，適當(dāng)?shù)那闆r下可以將計算結(jié)果緩存起來。
6. 減少單例的使用。
7. 提供一個統(tǒng)一的數(shù)據(jù)管理入口，不管是 MVC、MVVM、MVP 模塊內(nèi)提供一個統(tǒng)一的數(shù)據(jù)管理入口會使得代碼變得更容易管理和維護(hù)。
8. 空行、空格的合理使用如下方代碼：

// 類、協(xié)議等之間模塊間空行，同類不空行
NS_ASSUME_NONNULL_BEGIN

@class WKBackForwardList;
@class WKBackForwardListItem;
@class WKNavigation;
@class WKSnapshotConfiguration;
@class WKWebViewConfiguration;

@protocol WKNavigationDelegate;
@protocol WKUIDelegate;

// 屬性間空行，屬性的各個修飾詞之間空格
/*! @abstract A copy of the configuration with which the web view was
 initialized. */
@property (nonatomic, readonly, copy) WKWebViewConfiguration *configuration;

/*! @abstract The web view's navigation delegate. */
@property (nullable, nonatomic, weak) id <WKNavigationDelegate> navigationDelegate;

/*! @abstract The web view's user interface delegate. */
@property (nullable, nonatomic, weak) id <WKUIDelegate> UIDelegate;

/*! @abstract The web view's back-forward list. */
@property (nonatomic, readonly, strong) WKBackForwardList *backForwardList;

// 方法間空行
- (instancetype)initWithFrame:(CGRect)frame configuration:(WKWebViewConfiguration *)configuration NS_DESIGNATED_INITIALIZER;

- (nullable instancetype)initWithCoder:(NSCoder *)coder NS_DESIGNATED_INITIALIZER;

/*! @abstract Navigates to a requested URL.
 @param request The request specifying the URL to which to navigate.
 @result A new navigation for the given request.
 */
- (nullable WKNavigation *)loadRequest:(NSURLRequest *)request;

// 方法實現(xiàn)名與實現(xiàn)體之間，空格
- (void)viewDidLoad {
    
    ///    
}

9. 延后原則。
   • 頭文件能在.m中引入就不要在.h中引入，可以使用前向聲明。
   • 能用臨時變量就不要用成員變量，能用成員變量就不要用屬性，能在.m中去做聲明就不要在.h中去做聲明。
   • 盡可能少的在.h中暴露方法。

變量

1. 一個變量最好只有一個作用，切勿為了節(jié)省代碼行數(shù)，覺得一個變量可以做多個用途。（單一原則）
2. 方法內(nèi)部如果有局部變量，那么局部變量應(yīng)該靠近在使用的地方，而不是全部在頂部聲明全部的局部變量。

運(yùn)算符

1. 1元運(yùn)算符和變量之間不需要空格。例如：++n
2. 2元運(yùn)算符與變量之間需要空格隔開。例如： containerWidth = 0.3 * Screen_Width
3. 當(dāng)有多個運(yùn)算符的時候需要使用括號來明確正確的順序，可讀性較好。例如： 2 << (1 + 2 * 3 - 4)

條件表達(dá)式

1. 當(dāng)有條件過多、過長的時候需要換行，為了代碼看起來整齊些

//good
if (condition1() && 
    condition2() && 
    condition3() && 
    condition4()) {
  // Do something
}
//bad
if (condition1() && condition2() && condition3() && condition4(）) { // Do something }

1. 在一個代碼塊里面有個可能的情況時善于使用 return 來結(jié)束異常的情況。

- (void)doHomework {
    if (self.hungry) {
        return;
    }
    if (self.thirsty) {
        return;
    }
    if (self.tired) {
        return;
    }
    papapa.then.over;
}

1. 每個分支的實現(xiàn)都必須使用 {} 包含。

// bad
if (self.hungry) self.eat() 
// good
if (self.hungry) {
    self.eat()
}

1. 條件判斷的時候應(yīng)該是變量在左，條件在右。 if ( currentCursor == 2 ) { //... }
2. switch 語句后面的每個分支都需要用大括號括起來。
3. switch 語句后面的 default 分支必須存在，除非是在對枚舉進(jìn)行 switch。

switch (menuType) {  
  case menuTypeLeft: {
    // ...  
    break; 
   }
  case menuTypeRight: {
    // ...  
    break; 
  }
  case menuTypeTop: {
    // ...  
    break; 
  }
  case menuTypeBottom: {
    // ...  
    break; 
  }
}

類名

1. 大寫駝峰式命名。每個單詞首字母大寫。比如「申請記錄控制器」ApplyRecordsViewController
2. 每個類型的命名以該類型結(jié)尾。
   • ViewController：使用 ViewController 結(jié)尾。例子：ApplyRecordsViewController
   • View：使用 View 結(jié)尾。例子：分界線：boundaryView
   • NSArray：使用 s 結(jié)尾。比如商品分類數(shù)據(jù)源。categories
   • UITableViewCell：使用 Cell 結(jié)尾。比如 MyProfileCell
   • Protocol：使用 Delegate 或者 Datasource 結(jié)尾。比如 XQScanViewDelegate
   • Tool：工具類
   • 代理類：Delegate
   • Service 類：Service

類的注釋

有時候我們需要為我們創(chuàng)建的類設(shè)置一些注釋。我們可以在類的下面添加。

枚舉

枚舉的命名和類的命名相近。

typedef NS_ENUM(NSInteger, UIControlContentVerticalAlignment) {
    UIControlContentVerticalAlignmentCenter  = 0,
    UIControlContentVerticalAlignmentTop     = 1,
    UIControlContentVerticalAlignmentBottom  = 2,
    UIControlContentVerticalAlignmentFill    = 3,
};

宏

1. 全部大寫，單詞與單詞之間用 _ 連接。
2. 以 k 開頭。后面遵循大寫駝峰命名。「不帶參數(shù)」

#define HOME_PAGE_DID_SCROLL @"com.xq.home.page.tableview.did.scroll"
#define kHomePageDidScroll @"com.xq.home.page.tableview.did.scroll"

屬性

書寫規(guī)則，基本上就是 @property 之后空一格，括號，里面的 線程修飾詞、內(nèi)存修飾詞、讀寫修飾詞，空一格 類 對象名稱
根據(jù)不同的場景選擇合適的修飾符。

@property (nonatomic, strong) UITableView *tableView;
@property (nonatomic, assign, readonly) BOOL loading;   
@property (nonatomic, weak) id<#delegate#> delegate;
@property (nonatomic, copy) <#returnType#> (^<#Block#>)(<#parType#>);

單例

單例適合全局管理狀態(tài)或者事件的場景。一旦創(chuàng)建，對象的指針保存在靜態(tài)區(qū)，單例對象在堆內(nèi)存中分配的內(nèi)存空間只有程序銷毀的時候才會釋放。基于這種特點，那么我們類似 UIApplication 對象，需要全局訪問唯一一個對象的情況才適合單例，或者訪問頻次較高的情況。我們的功能模塊的生命周期肯定小于 App 的生命周期，如果多個單例對象的話，勢必 App 的開銷會很大，糟糕的情況系統(tǒng)會殺死 App。如果覺得非要用單例比較好，那么注意需要在合適的場合 tearDown 掉。

單例的使用場景概括如下：

• 控制資源的使用，通過線程同步來控制資源的并發(fā)訪問。
• 控制實例的產(chǎn)生，以達(dá)到節(jié)約資源的目的。
• 控制數(shù)據(jù)的共享，在不建立直接關(guān)聯(lián)的條件下，讓多個不相關(guān)的進(jìn)程或線程之間實現(xiàn)通信。

+ (instancetype)sharedInstance {
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        //because has rewrited allocWithZone  use NULL avoid endless loop lol.
        _sharedInstance = [[super allocWithZone:NULL] init];
    });
    
    return _sharedInstance;
}

+ (id)allocWithZone:(struct _NSZone *)zone {
    return [TestNSObject sharedInstance];
}

+ (instancetype)alloc {
    return [TestNSObject sharedInstance];
}

- (id)copy {
    return self;
}

- (id)mutableCopy {
    return self;
}

- (id)copyWithZone:(struct _NSZone *)zone {
    return self;
}

私有變量

推薦以 _ 開頭，寫在 .m 文件中。例如 NSString * _somePrivateVariable

代理方法

1. 類的實例必須作為方法的參數(shù)之一。
2. 對于一些連續(xù)的狀態(tài)的，可以加一些 will（將要）、did（已經(jīng)）
3. 以類的名稱開頭

- (void)tableView:(UITableView *)tableView willDisplayCell:(UITableViewCell *)cell forRowAtIndexPath:(NSIndexPath *)indexPath;

- (void)tableView:(UITableView *)tableView didEndDisplayingCell:(UITableViewCell *)cell forRowAtIndexPath:(NSIndexPath *)indexPath;

方法

1. 方法與方法之間間隔一行
2. 大量的方法盡量要以組的形式放在一起，比如生命周期函數(shù)、公有方法、私有方法、setter && getter、代理方法..
3. 方法最后面的括號需要另起一行。遵循 Apple 的規(guī)范
4. 對于其他場景的括號，括號不需要單獨(dú)換行。比如 if 后面的括號。
5. 如果方法參數(shù)過多過長，建議多行書寫。用冒號進(jìn)行對齊。
6. 一個方法內(nèi)的代碼最好保持在50行以內(nèi)，一般經(jīng)驗來看如果一個方法里面的代碼行數(shù)過多，代碼的閱讀體驗就很差（別問為什么，做過重構(gòu)代碼行數(shù)很長的人都有類似的心情）
7. 一個函數(shù)只做一個事情，做到單一原則。所有的類、方法設(shè)計好后就可以類似搭積木一樣實現(xiàn)一個系統(tǒng)。
8. 對于有返回值的函數(shù)，且函數(shù)內(nèi)有分支情況。確保每個分支都有返回值。
9. 函數(shù)如果有多個參數(shù)，外部傳入的參數(shù)需要檢驗參數(shù)的非空、數(shù)據(jù)類型的合法性，參數(shù)錯誤做一些措施：立即返回、斷言。
10. 多個函數(shù)如果有邏輯重復(fù)的代碼，建議將重復(fù)的部分抽取出來，成為獨(dú)立的函數(shù)進(jìn)行調(diào)用

- (instancetype)init {
    self = [super init];
    if (self) {
        <#statements#>
    }
    return self;
}

- (void)doHomework:(NSString *)name
            period:(NSInteger)second
            score:(NSInteger)score;

1. 方法如果有多個參數(shù)的情況下需要注意是否需要介詞和連詞。很多時候在不知道如何抉擇測時候思考下蘋果的一些 API 的方法命名。

//good
- (instancetype)initWithAge:(NSInteger)age name:(NSString *)name;

- (void)tableView:(UITableView *)tableView didSelectRowAtIndexPath:(NSIndexPath *)indexPath;


//bad
- (instancetype)initWithAge:(NSInteger)age andName:(NSString *)name;

- (void)tableView:(UITableView *)tableView :(NSIndexPath *)indexPath;

1. .m 文件中的私有方法需要在頂部進(jìn)行聲明
2. 方法組之間也有個順序問題。

• 在文件最頂部實現(xiàn)屬性的聲明、私有方法的聲明（很多人省去這一步，問題不大，但是蠻多第三方的庫都寫了，看起來還是會很方便，建議書寫）。
• 在生命周期的方法里面，比如 viewDidLoad 里面只做界面的添加，而不是做界面的初始化，所有的 view 初始化建議放在 getter 里面去做。往往 view 的初始化的代碼長度會比較長、且一般會有多個 view 所以 getter 和 setter 一般建議放在最下面，這樣子頂部就可以很清楚的看到代碼的主要邏輯。
• 所有button、gestureRecognizer 的響應(yīng)事件都放在這個區(qū)域里面，不要到處亂放。

文件基本上就是

//___FILEHEADER___

#import "___FILEBASENAME___.h"
/*ViewController*/

/*View&&Util*/

/*model*/

/*NetWork InterFace*/

/*Vender*/

@interface ___FILEBASENAMEASIDENTIFIER___ ()

@end

@implementation ___FILEBASENAMEASIDENTIFIER___


#pragma mark - life cycle
- (void)viewWillAppear:(BOOL)animated {
    [super viewDidAppear:animated];
}

- (void)viewDidAppear:(BOOL)animated {
    [super viewDidAppear:animated];
    
}

- (void)viewDidLoad {
    [super viewDidLoad];
    self.title = <#value#>;
}

- (void)viewWillDisappear:(BOOL)animated {
    [super viewDidAppear:animated];
    
}

- (void)viewDidDisappear:(BOOL)animated {
    [super viewDidAppear:animated];
    
}

#ifdef DEBUG
- (void)dealloc {
    NSLog(@"%s",__func__);
}
#endif

#pragma mark - public Method

#pragma mark - private method

#pragma mark - event response



#pragma mark - UITableViewDelegate

#pragma mark - UITableViewDataSource
//...(多個代理方法依次往下寫)

#pragma mark - getters and setters

@end

圖片資源

1. 單個文件的命名
   文件資源的命名也需要一定的規(guī)范，形式為：功能模塊名類別功能_狀態(tài)@nx.png
   Setting_Button_search_selected@2x.png、Setting_Button_search_selected@3x.png
   Setting_Button_search_unselected@2x.png、Setting_Button_search_unselected@3x.png
2. 資源的文件夾命名
   最好也參考 App 按照功能模塊建立對應(yīng)的實體文件夾目錄，最后到對應(yīng)的目錄下添加相應(yīng)的資源文件。

注釋

1. 對于類的注釋寫在當(dāng)前類文件的頂部
2. 對于屬性的注釋需要寫在屬性后面的地方。 //**/
3. 對于 .h 文件中方法的注釋，一律按快捷鍵 command+option+/。三個快捷鍵解決。按需在旁邊對方法進(jìn)行說明解釋、返回值、參數(shù)的說明和解釋
4. 對于 .m 文件中的方法的注釋，在方法的旁邊添加 //。
5. 注釋符和注釋內(nèi)容需要間隔一個空格。 例如： // fetch goods list

版本規(guī)范

采用 A.B.C 三位數(shù)字命名，比如：1.0.2，當(dāng)有更新的情況下按照下面的依據(jù)