前言

在一個(gè)開發(fā)團(tuán)隊(duì)中悦即，大家各有各的代碼規(guī)范，長(zhǎng)此以往項(xiàng)目將變得越來越難以維護(hù)恋追，下面我結(jié)合自己的日常規(guī)范同時(shí)參考同行的一些規(guī)范整理 Objective-C 版iOS客戶端代碼規(guī)范如下：
參考：Apple OC 編碼規(guī)范
搜狐

目錄

命名
注釋
代碼格式
編碼風(fēng)格
設(shè)計(jì)模式

命名

基本原則：清晰
盡可能遵守 Apple 的命名約定搭独，命名應(yīng)該盡可能的清晰和簡(jiǎn)潔节值，但在Objective-C中，清晰比簡(jiǎn)潔更重要。

• 類名采用大駝峰（UpperCamelCase）
• 類成員焰情、方法小駝峰（lowerCamelCase）
• 局部變量大小寫首選小駝峰陌凳，也可使用小寫下劃線的形式（snake_case）
• C函數(shù)的命名用大駝峰

推薦：

insertObject:atIndex:
removeObjectAtIndex

反對(duì)：

// insert的對(duì)象類型和at的位置屬性沒有說明
insert:at:
// remove的對(duì)象類型沒有說明，參數(shù)的作用沒有說明
remove:

不要使用單詞的簡(jiǎn)寫内舟，拼寫出完整的單詞：
推薦：

ID, URL, JSON, WWW
destinationSelection
setBackgroundColor:

反對(duì)：

id, Url, json, www
// 不要使用簡(jiǎn)寫
destSel
setBkgdColor:

一致性

整個(gè)工程的命名風(fēng)格要保持一致性合敦，最好和蘋果SDK的代碼保持統(tǒng)一。不同類中完成相似功能的方法應(yīng)該叫一樣的名字验游，比如我們總是用count來返回集合的個(gè)數(shù)充岛，不能在A類中使用count而在B類中使用getNumber。
如果代碼需要打包成Framework給別的工程使用耕蝉，或者工程項(xiàng)目非常龐大崔梗，需要拆分成不同的模塊，使用命名前綴是非常有用的垒在。

• 前綴由大寫的字母縮寫組成蒜魄，比如Cocoa中NS前綴代表Founation框架中的類，IB則代表Interface Builder框架爪膊。
• 可以在為類权悟、協(xié)議、函數(shù)推盛、常量以及typedef宏命名的時(shí)候使用前綴峦阁，但注意不要為成員變量或者方法使用前綴，因?yàn)樗麄儽旧砭桶陬惖拿臻g內(nèi)耘成。
• 命名前綴的時(shí)候不要和蘋果SDK框架沖突榔昔。

通常我們整個(gè)項(xiàng)目應(yīng)有統(tǒng)一的前綴，比如用公司英文名：AS(aerospace)瘪菌、HT(hangtian)撒会，若提供給外部一些Framework可相應(yīng)在統(tǒng)一前綴后加相應(yīng)前綴如：ASC(航天通勤 Aerospace commuter)、AST(航天差旅 Aerospace travel)

命名類和協(xié)議

類名以大寫字母開頭师妙，應(yīng)該包含一個(gè)名詞來表示它代表的對(duì)象類型诵肛，同時(shí)可以加上必要的前綴，比如NSString, NSDate, NSScanner, NSApplication等等默穴。

協(xié)議名稱應(yīng)該清晰地表示它所執(zhí)行的行為怔檩，而且要和類名區(qū)別開來，所以通常使用ing詞尾來命名一個(gè)協(xié)議蓄诽，比如NSCopying薛训、NSLocking。

在我們實(shí)際項(xiàng)目中仑氛，通常使用很多協(xié)議-委托模式乙埃，此時(shí)應(yīng)以Delegate闸英、DataSource詞尾來命名一個(gè)協(xié)議，比如UITableViewDelegate介袜、UITableViewDataSource甫何，delegate偏重于用戶交互的回調(diào)協(xié)議，datasource偏重于數(shù)據(jù)的回調(diào)協(xié)議遇伞。

命名頭文件

• 如果頭文件內(nèi)只定義了單個(gè)類或者協(xié)議沛豌，直接用類名或者協(xié)議名來命名頭文件，比如NSLocale.h定義了NSLocale類赃额。
• 如果頭文件內(nèi)定義了一系列的類加派、協(xié)議、類別跳芳，使用其中最主要的類名來命名頭文件芍锦，比如NSString.h定義了NSString和NSMutableString。
• 每一個(gè)Framework都應(yīng)該有一個(gè)和框架同名的頭文件飞盆，包含了框架中所有公共類頭文件的引用娄琉，比如Foundation.h
• 在我們的項(xiàng)目中，我們可以使用PCH文件來包含項(xiàng)目中所有公共類文件的引用吓歇，但公共類文件最好有分類（區(qū)分）孽水，比如邏輯處理相關(guān)、UI相關(guān)城看、日期相關(guān)女气、校驗(yàn)相關(guān)、加密相關(guān)等测柠。

命名方法

Objective-C的方法名通常都比較長(zhǎng)炼鞠，這是為了讓程序有更好地可讀性，按蘋果的說法“好的方法名應(yīng)當(dāng)可以以一個(gè)句子的形式朗讀出來”轰胁。

方法一般以小寫字母打頭谒主，每一個(gè)后續(xù)的單詞首字母大寫，方法名中不應(yīng)該有標(biāo)點(diǎn)符號(hào)（包括下劃線）赃阀，有兩個(gè)例外：

• 可以用一些通用的大寫字母縮寫打頭方法霎肯，比如PDF、TIFF等榛斯。
• 可以用帶下劃線的前綴來命名私有方法或者類別中的方法观游。

如果方法表示讓對(duì)象執(zhí)行一個(gè)動(dòng)作，使用動(dòng)詞打頭來命名肖抱，注意不要使用do备典，does這種多余的關(guān)鍵字冬三，動(dòng)詞本身的暗示就足夠了：

// 動(dòng)詞打頭的方法表示讓對(duì)象執(zhí)行一個(gè)動(dòng)作
- (void)invokeWithTarget:(id)target;
- (void)selectTabViewItem:(NSTabViewItem *)tabViewItem;

如果方法是為了獲取對(duì)象的一個(gè)屬性值膏秫，直接用屬性名稱來命名這個(gè)方法，注意不要添加get或者其他的動(dòng)詞前綴：

推薦：

// 使用屬性名來命名方法
- (NSSize)cellSize;

反對(duì)：

// 添加了多余的動(dòng)詞前綴
- (NSSize)calcCellSize;
- (NSSize)getCellSize;

對(duì)于有多個(gè)參數(shù)的方法方妖，務(wù)必在每一個(gè)參數(shù)前都添加關(guān)鍵詞荤崇，關(guān)鍵詞應(yīng)當(dāng)清晰說明參數(shù)的作用：

推薦：

// 保證每個(gè)參數(shù)都有關(guān)鍵詞修飾
- (void)sendAction:(SEL)aSelector toObject:(id)anObject forAllCells:(BOOL)flag;
- (id)viewWithTag:(NSInteger)aTag;

反對(duì)：

// 遺漏關(guān)鍵詞
- (void)sendAction:(SEL)aSelector :(id)anObject :(BOOL)flag;
// 關(guān)鍵詞的作用不清晰
- (id)taggedView:(int)aTag;

不要用and來連接兩個(gè)參數(shù)拌屏，通常and用來表示方法執(zhí)行了兩個(gè)相對(duì)獨(dú)立的操作（從設(shè)計(jì)上來說，這時(shí)候應(yīng)該拆分成兩個(gè)獨(dú)立的方法）：

推薦：

// 使用"and"來表示兩個(gè)相對(duì)獨(dú)立的操作
- (BOOL)openFile:(NSString *)fullPath withApplication:(NSString *)appName andDeactivate:(BOOL)flag;

反對(duì)：

// 不要使用"and"來連接參數(shù)
- (int)runModalForDirectory:(NSString *)path andFile:(NSString *)name andTypes:(NSArray *)fileTypes;

方法的參數(shù)命名也有一些需要注意的地方:

• 和方法名類似术荤，參數(shù)的第一個(gè)字母小寫倚喂，后面的每一個(gè)單詞首字母大寫
• 不要在方法名中使用類似pointer、ptr這樣的字眼去表示指針瓣戚，參數(shù)本身的類型足以說明
• 不要使用只有一兩個(gè)字母的參數(shù)名
• 不要使用簡(jiǎn)寫端圈，拼出完整的單詞

下面列舉了一些常用參數(shù)名：

...action:(SEL)aSelector
...alignment:(int)mode
...atIndex:(int)index
...content:(NSRect)aRect
...doubleValue:(double)aDouble
...floatValue:(float)aFloat
...font:(NSFont *)fontObj
...frame:(NSRect)frameRect
...intValue:(int)anInt
...keyEquivalent:(NSString *)charCode
...length:(int)numBytes
...point:(NSPoint)aPoint
...stringValue:(NSString *)aString
...tag:(int)anInt
...target:(id)anObject
...title:(NSString *)aString

命名委托

當(dāng)特定的事件發(fā)生時(shí)，對(duì)象會(huì)觸發(fā)它注冊(cè)的委托方法子库。委托是Objective-C中常用的傳遞消息的方式舱权。委托有它固定的命名范式。

一個(gè)委托方法的第一個(gè)參數(shù)是觸發(fā)它的對(duì)象仑嗅，第一個(gè)關(guān)鍵詞是觸發(fā)對(duì)象的類名宴倍，除非委托方法只有一個(gè)名為sender的參數(shù)：

// 第一個(gè)關(guān)鍵詞為觸發(fā)委托的類名
- (BOOL)tableView:(NSTableView *)tableView shouldSelectRow:(int)row;
- (BOOL)application:(NSApplication *)sender openFile:(NSString *)filename;

// 當(dāng)只有一個(gè)"sender"參數(shù)時(shí)可以省略類名
- (BOOL)applicationOpenUntitledFile:(NSApplication *)sender;

// 根據(jù)委托方法觸發(fā)的時(shí)機(jī)和目的，使用should仓技、will鸵贬、did等關(guān)鍵詞
- (void)browserDidScroll:(NSBrowser *)sender;
- (NSUndoManager *)windowWillReturnUndoManager:(NSWindow *)window;
- (BOOL)windowShouldClose:(id)sender;

集合操作類方法

有些對(duì)象管理著一系列其它對(duì)象或者元素的集合，需要使用類似“增刪查改”的方法來對(duì)集合進(jìn)行操作脖捻，這些方法的命名范式一般為：

// 集合操作范式
- (void)addElement:(elementType)anObj;
- (void)removeElement:(elementType)anObj;
- (NSArray *)elements;

// 例子
- (void)addLayoutManager:(NSLayoutManager *)obj;
- (void)removeLayoutManager:(NSLayoutManager *)obj;
- (NSArray *)layoutManagers;

注意阔逼，如果返回的集合是無序的，使用NSSet來代替NSArray地沮。如果需要將元素插入到特定的位置颜价，使用類似于這樣的命名：

- (void)insertLayoutManager:(NSLayoutManager *)obj atIndex:(int)index;
- (void)removeLayoutManagerAtIndex:(int)index;

如果管理的集合元素中有指向管理對(duì)象的指針，要設(shè)置成weak類型以防止引用循環(huán)诉濒。

比如項(xiàng)目中有很多使用 UIWindow 的場(chǎng)景周伦，為了避免多人合作開發(fā)對(duì) UIWindow 使用的隨意性，我么可以封裝一些常用的 UIWindow 使用方法：

// 注意未荒，下面是參考 macOS 開發(fā)里常用的 NSWindow類的集合操作方法
- (void)addChildWindow:(NSWindow *)childWin ordered:(NSWindowOrderingMode)place;
- (void)removeChildWindow:(NSWindow *)childWin;
- (NSArray *)childWindows;
- (NSWindow *)parentWindow;
- (void)setParentWindow:(NSWindow *)window;

命名屬性和成員變量

屬性和對(duì)象的存取方法相關(guān)聯(lián)专挪，屬性的第一個(gè)字母小寫，后續(xù)單詞首字母大寫片排，不必添加前綴寨腔。屬性按功能命名成名詞或者動(dòng)詞，也可以命名成形容詞率寡，這時(shí)候通常會(huì)指定一個(gè)帶有is前綴的get方法來提高可讀性：

// 名詞屬性
@property (strong) NSString *title;
// 動(dòng)詞屬性
@property (assign) BOOL showsAlpha;
// 形容詞屬性
@property (assign, getter=isEditable) BOOL editable;

命名成員變量迫卢，在變量名前加上前綴（有些有歷史的代碼會(huì)將放在后面），其它和命名屬性一樣：

@implementation MyClass {
    BOOL _showsTitle;
}

一般來說冶共，類需要對(duì)使用者隱藏?cái)?shù)據(jù)存儲(chǔ)的細(xì)節(jié)乾蛤，所以不要將實(shí)例方法定義成公共可訪問的接口每界。

注意：

針對(duì)我們的項(xiàng)目，我建議減少對(duì)成員變量的使用家卖，多使用屬性眨层。
關(guān)于使用屬性與成員變量，參考：iOS鞏基之 不再糾結(jié)實(shí)例變量&屬性

命名常量

如果要定義一組相關(guān)的常量上荡，盡量使用枚舉類型（enumerations）趴樱，枚舉類型的命名規(guī)則和函數(shù)的命名規(guī)則相同。
建議使用 NS_ENUM 和 NS_OPTIONS 宏來定義枚舉類型酪捡，參見官方的 Adopting Modern Objective-C 一文：

// 定義一個(gè)枚舉
typedef NS_ENUM(NSInteger, NSMatrixMode) {
    NSRadioModeMatrix,
    NSHighlightModeMatrix,
    NSListModeMatrix,
    NSTrackModeMatrix
};

使用const定義浮點(diǎn)型或者單個(gè)的整數(shù)型常量叁征，如果要定義一組相關(guān)的整數(shù)常量，應(yīng)該優(yōu)先使用枚舉逛薇。常量的命名規(guī)范和函數(shù)相同：

// 在 OC 中航揉，通常常量定義加一個(gè)前綴 k
const float kLightGray;

不要使用#define宏來定義常量，如果是整型常量金刁，盡量使用枚舉帅涂，浮點(diǎn)型常量，使用const定義尤蛮。#define通常用來給編譯器決定是否編譯某塊代碼媳友，比如常用的：

#ifdef DEBUG

注意到一般由編譯器定義的宏會(huì)在前后都有一個(gè)__，比如MACH产捞。

命名通知

通知常用于在模塊間傳遞消息醇锚，所以通知要盡可能地表示出發(fā)生的事件，通知的命名范式是：

[觸發(fā)通知的類名] + [Did | Will] + [動(dòng)作] + Notification
// 例如：
NSApplicationDidBecomeActiveNotification
NSWindowDidMiniaturizeNotification
NSTextViewDidChangeSelectionNotification
NSColorPanelColorDidChangeNotification

圖片命名

1.用英文命名坯临，盡量不用拼音焊唬；
2.每一部分用'-'分隔。分割的第一個(gè)首字母大寫看靠；
3.盡量表現(xiàn)內(nèi)容+使用類型赶促；
4.盡量同一頁面放置在同一個(gè)文件夾下。

推薦：

Download-Progressbar-Highlighted@2x.png
Download-Progressbar-Normal@2x.png

注釋

讀沒有注釋代碼的痛苦我們應(yīng)該都體會(huì)過挟炬，好的注釋不僅能讓人輕松讀懂你的程序鸥滨，還能提升代碼的逼格。注意注釋是為了讓別人看懂谤祖，而不是僅僅你自己婿滓。

文件注釋

當(dāng)我們需要對(duì)外提供 framework 的時(shí)候，每一個(gè)文件都必須寫文件注釋粥喜，文件注釋通常包含

• 文件所在模塊
• 作者信息
• 歷史版本信息
• 版權(quán)信息
• 文件包含的內(nèi)容凸主，作用
  一段良好文件注釋的例子：

/*******************************************************************************
    Copyright (C), 2011-2013, Andrew Min Chang

    File name:  AMCCommonLib.h
    Author:     Andrew Chang (Zhang Min) 
    E-mail:     LaplaceZhang@126.com
    
    Description:    
            This file provide some covenient tool in calling library tools. One can easily include 
        library headers he wants by declaring the corresponding macros. 
            I hope this file is not only a header, but also a useful Linux library note.
            
    History:
        2012-??-??: On about come date around middle of Year 2012, file created as "commonLib.h"
        2012-08-20: Add shared memory library; add message queue.
        2012-08-21: Add socket library (local)
        2012-08-22: Add math library
        2012-08-23: Add socket library (internet)
        2012-08-24: Add daemon function
        2012-10-10: Change file name as "AMCCommonLib.h"
        2012-12-04: Add UDP support in AMC socket library
        2013-01-07: Add basic data type such as "sint8_t"
        2013-01-18: Add CFG_LIB_STR_NUM.
        2013-01-22: Add CFG_LIB_TIMER.
        2013-01-22: Remove CFG_LIB_DATA_TYPE because there is already AMCDataTypes.h

    Copyright information: 
            This file was intended to be under GPL protocol. However, I may use this library
        in my work as I am an employee. And my company may require me to keep it secret. 
        Therefore, this file is neither open source nor under GPL control. 
        
********************************************************************************/

文件注釋的格式通常不作要求，能清晰易讀就可以了额湘，但在整個(gè)工程中風(fēng)格要統(tǒng)一卿吐。

代碼注釋

好的代碼應(yīng)該是“自解釋”（self-documenting）的旁舰，但仍然需要詳細(xì)的注釋來說明參數(shù)的意義、返回值但两、功能以及可能的副作用。

方法供置、函數(shù)谨湘、類、協(xié)議芥丧、類別的定義都需要注釋紧阔，推薦采用Apple的標(biāo)準(zhǔn)注釋風(fēng)格，好處是可以在引用的地方 option + 點(diǎn)擊 自動(dòng)彈出注釋续担，非常方便擅耽。

當(dāng)前 Xcode 已經(jīng)集成了某大神寫的自動(dòng)生成注釋的插件。（快捷鍵物遇，光標(biāo)放在方法或?qū)傩缘刃枰砑幼⑨尩拇a上一行乖仇，點(diǎn)擊 option + command + /，剩下的就是我們需要寫好注釋了）询兴。

下面是我封裝的個(gè)別接口的注釋（方法名已修改）

/// 差旅和通勤登錄接口
/// @param username 用戶手機(jī)號(hào)
/// @param busType 業(yè)務(wù)類型 ：a 是差旅 b 是通勤
/// @param success 成功回調(diào)
/// @param failure 失敗回調(diào)
+ (void)requestXXXType:(NSString *)username busType:(NSString *)busType success:(success)success failure:(failure)failure;

協(xié)議乃沙、委托的注釋要明確說明其被觸發(fā)的條件。
定義在頭文件里的接口方法诗舰、屬性必須要有注釋警儒！

普通注釋，切記雙斜線（//）與注釋文字之間應(yīng)有空格眶根！

// 注釋和雙斜線間要有空格蜀铲！

代碼格式

每一行的最大長(zhǎng)度（不做硬性要求）

同樣的，在Xcode > Preferences > Text Editing > Page guide at column:中將最大行長(zhǎng)設(shè)置為80属百，過長(zhǎng)的一行代碼將會(huì)導(dǎo)致可讀性問題记劝。

空格

類方法聲明在方法類型與返回類型之間要有空格。

推薦：

// 不論是 + 方法或是 - 方法族扰，都應(yīng)與返回類型之間有一個(gè)空格
- (void)methodName:(NSString *)string;

反對(duì)：

-(void)methodName:(NSString *)string;

條件判斷的括號(hào)內(nèi)側(cè)不應(yīng)有空格隆夯。

推薦：

if (a < b) {
    // something
}

反對(duì)：

if ( a < b ) {
    // something
}

關(guān)系運(yùn)算符（如 >=、!=）和邏輯運(yùn)算符（如 &&别伏、||）兩邊要有空格蹄衷。

推薦：

(someValue > 100)? YES : NO

二元算數(shù)運(yùn)算符兩側(cè)是否加空格不確定，根據(jù)情況自己定厘肮。一元運(yùn)算符與操作數(shù)之前沒有空格愧口。

方法的書寫

一個(gè)典型的 Objective-C 方法應(yīng)該是這樣的：

- (void)writeVideoFrameWithData:(NSData *)frameData timeStamp:(int)timeStamp {
    ...
}

在-和(void)之間應(yīng)該有一個(gè)空格，第一個(gè)大括號(hào){的位置在函數(shù)所在行的末尾类茂，同樣應(yīng)該有一個(gè)空格耍属。

.m 文件中托嚣，兩個(gè)方法的實(shí)現(xiàn)之間應(yīng)留有一行空行，代碼應(yīng)該緊湊厚骗，增加可讀性示启，方法內(nèi)的代碼塊不應(yīng)該都空一或多行寫。

推薦：

- (UIButton *)loginButton {
    if (!_loginButton) {
        UIButton * button = [UIButton buttonWithType:UIButtonTypeCustom];
        [button setTitle:@"登錄" forState:UIControlStateNormal];
        button.backgroundColor = [UIColor cyanColor];
        button.layer.cornerRadius = 4;
        button.clipsToBounds = YES;
        
        [self.view addSubview:button];
        _loginButton = button;
    }
    return _loginButton;
}

反對(duì)：

// 不易復(fù)用
- (UIButton *)loginButton {
    if (!_loginButton) {
        _loginButton = [UIButton buttonWithType:UIButtonTypeCustom];
        [_loginButton setTitle:@"登錄" forState:UIControlStateNormal];
        _loginButton.backgroundColor = [UIColor cyanColor];
        _loginButton.layer.cornerRadius = 4;
        _loginButton.clipsToBounds = YES;
        [self.view addSubview:_loginButton];
    }
    return _loginButton;
}

// 考慮下屏幕的大小及可讀性领舰，當(dāng)一個(gè)方法占了一個(gè)屏幕夫嗓，讀起來真的很鬧心。
- (UIButton *)loginButton {

    if (!_loginButton) {

        UIButton * button = [UIButton buttonWithType:UIButtonTypeCustom];

        [button setTitle:@"登錄" forState:UIControlStateNormal];

        button.backgroundColor = [UIColor cyanColor];

        button.layer.cornerRadius = 4;

        button.clipsToBounds = YES;
        
        [self.view addSubview:button];

        _loginButton = button;

    }

    return _loginButton;

}

如果一個(gè)函數(shù)有特別多的參數(shù)或者名稱很長(zhǎng)冲秽，應(yīng)該將其按照:來對(duì)齊分行顯示：

- (id)initWithModel:(IPCModle)model
        ConnectType:(IPCConnectType)connectType
         Resolution:(IPCResolution)resolution
           AuthName:(NSString *)authName
           Password:(NSString *)password
                MAC:(NSString *)mac
               AzIp:(NSString *)az_ip
              AzDns:(NSString *)az_dns
              Token:(NSString *)token
              Email:(NSString *)email
           Delegate:(id<IPCConnectHandlerDelegate>)delegate;

在分行時(shí)舍咖，如果第一段名稱過短，后續(xù)名稱可以以Tab的長(zhǎng)度（4個(gè)空格）為單位進(jìn)行縮進(jìn)：

- (void)short:(GTMFoo *)theFoo
        longKeyword:(NSRect)theRect
  evenLongerKeyword:(float)theInterval
              error:(NSError **)theError {
    ...
}

方法調(diào)用

方法調(diào)用的格式和書寫差不多锉桑，可以按照方法的長(zhǎng)短來選擇寫在一行或者分成多行：

推薦：

//寫在一行
[myObject doFooWith:arg1 name:arg2 error:arg3];

//分行寫排霉，按照':'對(duì)齊
[myObject doFooWith:arg1
               name:arg2
              error:arg3];

//第一段名稱過短的話后續(xù)可以進(jìn)行縮進(jìn)
[myObj short:arg1
          longKeyword:arg2
    evenLongerKeyword:arg3
                error:arg4];

反對(duì)：

//錯(cuò)誤，要么寫在一行民轴，要么全部分行
[myObject doFooWith:arg1 name:arg2
              error:arg3];
[myObject doFooWith:arg1
               name:arg2 error:arg3];

//錯(cuò)誤攻柠，按照':'來對(duì)齊，而不是關(guān)鍵字
[myObject doFooWith:arg1
          name:arg2
          error:arg3];

協(xié)議（Protocols）

在書寫協(xié)議的時(shí)候注意用<>括起來的協(xié)議和類型名之間是沒有空格的后裸，比如IPCConnectHandler()<IPCPreconnectorDelegate>辙诞，這個(gè)規(guī)則適用所有書寫協(xié)議的地方，包括函數(shù)及方法聲明轻抱、類聲明飞涂、實(shí)例變量等等：

// 參考 iOS SDK
@interface MyProtocoledClass : NSObject<NSWindowDelegate>

閉包（Blocks）

根據(jù)block的長(zhǎng)度，有不同的書寫規(guī)則：

• 較短的block可以寫在一行內(nèi)祈搜。
• 如果分行顯示的話较店，block的右括號(hào)}應(yīng)該和調(diào)用block那行代碼的第一個(gè)非空字符對(duì)齊。
• block內(nèi)的代碼采用4個(gè)空格的縮進(jìn)容燕。
• 如果block過于龐大梁呈，應(yīng)該單獨(dú)聲明成一個(gè)變量來使用。
• ^和(之間蘸秘，^和{之間都沒有空格官卡，參數(shù)列表的右括號(hào))和{之間有一個(gè)空格。

// 較短的block寫在一行內(nèi)
[operation setCompletionBlock:^{ [self onOperationDone]; }];

// 分行書寫的block醋虏，內(nèi)部使用4空格縮進(jìn)
[operation setCompletionBlock:^{
    [self.delegate newDataAvailable];
}];

// 使用C語言API調(diào)用的block遵循同樣的書寫規(guī)則
dispatch_async(_fileIOQueue, ^{
    NSString* path = [self sessionFilePath];
    if (path) {
      // ...
    }
});

// 較長(zhǎng)的block關(guān)鍵字可以縮進(jìn)后在新行書寫寻咒，注意block的右括號(hào)'}'和調(diào)用block那行代碼的第一個(gè)非空字符對(duì)齊
[[SessionService sharedService]
    loadWindowWithCompletionBlock:^(SessionWindow *window) {
        if (window) {
          [self windowDidLoad:window];
        } else {
          [self errorLoadingWindow];
        }
    }];

// 較長(zhǎng)的block參數(shù)列表同樣可以縮進(jìn)后在新行書寫
[[SessionService sharedService]
    loadWindowWithCompletionBlock:
        ^(SessionWindow *window) {
            if (window) {
              [self windowDidLoad:window];
            } else {
              [self errorLoadingWindow];
            }
        }];

// 龐大的block應(yīng)該單獨(dú)定義成變量或別名使用
void (^largeBlock)(void) = ^{
    // ...
};
typedef void(^someBlock)(NSString *someParam);
[_operationQueue addOperationWithBlock:largeBlock];

// 在一個(gè)調(diào)用中使用多個(gè)block，注意到他們不是像函數(shù)那樣通過':'對(duì)齊的颈嚼，而是同時(shí)進(jìn)行了4個(gè)空格的縮進(jìn)
[myObject doSomethingWith:arg1
    firstBlock:^(Foo *a) {
        // ...
    }
    secondBlock:^(Bar *b) {
        // ...
    }];

字面量語法糖

應(yīng)該使用可讀性更好的語法糖來構(gòu)造NSArray毛秘，NSDictionary等數(shù)據(jù)結(jié)構(gòu)，避免使用冗長(zhǎng)的alloc,init方法。

如果構(gòu)造代碼寫在一行叫挟，需要在括號(hào)兩端留有一個(gè)空格艰匙，使得被構(gòu)造的元素于與構(gòu)造語法區(qū)分開來：

推薦：

// 在語法糖的"[]"或者"{}"兩端留有空格
NSArray *array = @[ [foo description], @"Another String", [bar description] ];
NSDictionary *dict = @{ NSForegroundColorAttributeName : [NSColor redColor] };

反對(duì)：

// 不留有空格降低了代碼可讀性
NSArray* array = @[[foo description], [bar description]];
NSDictionary* dict = @{NSForegroundColorAttributeName: [NSColor redColor]};

如果構(gòu)造代碼不寫在一行內(nèi)，構(gòu)造元素需要使用兩個(gè)空格來進(jìn)行縮進(jìn)抹恳，右括號(hào)]或者}寫在新的一行员凝，并且與調(diào)用語法糖那行代碼的第一個(gè)非空字符對(duì)齊：

NSArray *array = @[
  @"This",
  @"is",
  @"an",
  @"array"
];

NSDictionary *dictionary = @{
  NSFontAttributeName : [NSFont fontWithName:@"Helvetica-Bold" size:12],
  NSForegroundColorAttributeName : fontColor
};

構(gòu)造字典時(shí)，字典的Key和Value與中間的冒號(hào):都要留有一個(gè)空格奋献，多行書寫時(shí)健霹，也可以將Value對(duì)齊：

推薦：

// 冒號(hào)':'前后留有一個(gè)空格
NSDictionary *option1 = @{
  NSFontAttributeName : [NSFont fontWithName:@"Helvetica-Bold" size:12],
  NSForegroundColorAttributeName : fontColor
};

// 按照Value來對(duì)齊
NSDictionary *option2 = @{
  NSFontAttributeName :            [NSFont fontWithName:@"Arial" size:12],
  NSForegroundColorAttributeName : fontColor
};

反對(duì)：

// 冒號(hào)前應(yīng)該有一個(gè)空格
NSDictionary *wrong = @{
  AKey:       @"b",
  BLongerKey: @"c",
};

// 每一個(gè)元素要么單獨(dú)成為一行，要么全部寫在一行內(nèi)
NSDictionary *alsoWrong= @{ AKey : @"a",
                            BLongerKey : @"b" };

// 在冒號(hào)前只能有一個(gè)空格秽荞，冒號(hào)后才可以考慮按照Value對(duì)齊
NSDictionary *stillWrong = @{
  AKey       : @"b",
  BLongerKey : @"c",
};

代碼組織

• 函數(shù)骤公、方法長(zhǎng)度（行數(shù)）不應(yīng)超過2/3屏幕抚官，通常我們建議不超過30行扬跋，當(dāng)你的一個(gè)方法行數(shù)過多，意味著這個(gè)方法可以優(yōu)化了凌节。（我們的老項(xiàng)目中一個(gè)方法五六十行甚至過百行都不奇怪）
• 單個(gè)文件方法數(shù)不應(yīng)超過30個(gè)钦听，單個(gè)文件的總行數(shù)也不應(yīng)超過500行，當(dāng)你的一個(gè)類文件總行數(shù)過千了倍奢，意味著這個(gè)類一定有很多的冗余代碼朴上。
• 一個(gè)文件中的代碼，通常我們應(yīng)該按一定類別排序（如 api 請(qǐng)求放在一起卒煞，push 放在一起）痪宰。
• 當(dāng)一個(gè)文件中代碼不是單一功能，我們可以考慮不按類別排序（如把IBAction放在一塊）畔裕，而按任務(wù)把相關(guān)的組合在一起衣撬。
• 禁止出現(xiàn)超過兩層循環(huán)的代碼，用方法其他方式替代扮饶。

推薦：

- (Task *)createTaskWithPath:(NSString *)path {
    if (![path isURL]) {
        return nil;
    }
    if (![fileManager isWritableFileAtPath:path]) {
        return nil;
    }
    if ([taskManager hasTaskWithPath:path]) {
        return nil;
    }

    Task *aTask = [[Task alloc] initWithPath:path];
    return aTask;
}

反對(duì)：

// 為了簡(jiǎn)化示例具练，沒有錯(cuò)誤處理，并使用了偽代碼
- (Task *)createTaskWithPath:(NSString *)path {
    Task *aTask;
    if ([path isURL]) {
        if ([fileManager isWritableFileAtPath:path]) {
            if (![taskManager hasTaskWithPath:path]) {
                aTask = [[Task alloc] initWithPath:path];
            }
            else {
                return nil;
            }
        }
        else {
            return nil;
        }
    }
    else {
        return nil;
    }
    return aTask;
}

編碼風(fēng)格

每個(gè)人都有自己的編碼風(fēng)格甜无，這里總結(jié)了一些比較好的 Cocoa 編程風(fēng)格和注意點(diǎn)扛点。

不要使用 new 方法

我在我們當(dāng)前的項(xiàng)目中發(fā)現(xiàn)很多地方使用 new 方法去實(shí)例化一個(gè)對(duì)象，盡管很多時(shí)候能用new代替alloc init方法岂丘，但這可能會(huì)導(dǎo)致調(diào)試內(nèi)存時(shí)出現(xiàn)不可預(yù)料的問題陵究。Cocoa的規(guī)范就是使用alloc init方法。

Public Api 要盡量簡(jiǎn)潔

共有接口要設(shè)計(jì)的簡(jiǎn)潔奥帘，滿足核心的功能需求就可以了畔乙。不要設(shè)計(jì)很少會(huì)被用到，但是參數(shù)極其復(fù)雜的API翩概。如果要定義復(fù)雜的方法牲距，使用類別或者類擴(kuò)展返咱。

#import 和 #include

import是Cocoa中常用的引用頭文件的方式，它能自動(dòng)防止重復(fù)引用文件牍鞠，什么時(shí)候使用#import咖摹，什么時(shí)候使用#include呢？

• 當(dāng)引用的是一個(gè)Objective-C或者Objective-C++的頭文件時(shí)难述，使用#import
• 當(dāng)引用的是一個(gè)C或者C++的頭文件時(shí)萤晴，使用#include，這時(shí)必須要保證被引用的文件提供了保護(hù)域（#define guard）胁后。

為什么不全部使用#import呢店读？主要是為了保證代碼在不同平臺(tái)間共享時(shí)不出現(xiàn)問題。

引用框架的根頭文件

每一個(gè)框架都會(huì)有一個(gè)和框架同名的頭文件攀芯，它包含了框架內(nèi)接口的所有引用屯断，在使用框架的時(shí)候，應(yīng)該直接引用這個(gè)根頭文件侣诺，而不是其它子模塊的頭文件殖演，即使是你只用到了其中的一小部分，編譯器會(huì)自動(dòng)完成優(yōu)化的年鸳。

推薦：

// 引用根頭文件
#import <Foundation/Foundation.h>

反對(duì)：

// 不要單獨(dú)引用框架內(nèi)的其它頭文件
#import <Foundation/NSArray.h>
#import <Foundation/NSString.h>

BOOL的使用

BOOL在Objective-C中被定義為signed char類型趴久，這意味著一個(gè)BOOL類型的變量不僅僅可以表示YES(1)和NO(0)兩個(gè)值，所以永遠(yuǎn)不要將BOOL類型變量直接和YES比較：

推薦：

BOOL great = [foo isGreat];
if (great)
  // ...be great!

反對(duì)：

// 無法確定|great|的值是否是YES(1)搔确，不要將BOOL值直接與YES比較
BOOL great = [foo isGreat];
if (great == YES)
  // ...be great!

也不要將其它類型的值作為BOOL來返回彼棍，這種情況下，BOOL變量只會(huì)取值的最后一個(gè)字節(jié)來賦值膳算，這樣很可能會(huì)取到0（NO）座硕。但是，一些邏輯操作符比如&&,||,!的返回是可以直接賦給BOOL的：

推薦：

- (BOOL)isBold {
  return ([self fontTraits] & NSFontBoldTrait) ? YES : NO;
}

// 邏輯操作符可以直接轉(zhuǎn)化為BOOL
- (BOOL)isValid {
  return [self stringValue] != nil;
}

- (BOOL)isEnabled {
  return [self isValid] && [self isBold];
}

反對(duì)：

// 不要將其它類型轉(zhuǎn)化為BOOL返回
- (BOOL)isBold {
  return [self fontTraits] & NSFontBoldTrait;
}
- (BOOL)isValid {
  return [self stringValue];
}

init和dealloc

建議將 init 和 dealloc 方法放在類文件的最前面畦幢，緊挨著坎吻。

當(dāng)init、dealloc方法被執(zhí)行時(shí)宇葱，類的運(yùn)行時(shí)環(huán)境不是處于正常狀態(tài)的瘦真，使用存取方法訪問變量可能會(huì)導(dǎo)致不可預(yù)料的結(jié)果，因此應(yīng)當(dāng)在這兩個(gè)方法內(nèi)直接訪問實(shí)例變量（當(dāng)我們創(chuàng)建一個(gè)屬性 school 時(shí)黍瞧，編譯器會(huì)自動(dòng)生成一個(gè)對(duì)應(yīng)的成員變量 _school）诸尽。

推薦：

// 直接訪問實(shí)例變量
- (instancetype)init {
  self = [super init];
  if (self) {
    _bar = [[NSMutableString alloc] init];
  }
  return self;
}
- (void)dealloc {
  [_bar release];
  [super dealloc];
}

反對(duì)：

// 不要通過存取方法訪問
- (instancetype)init {
  self = [super init];
  if (self) {
    self.bar = [NSMutableString string];
  }
  return self;
}
- (void)dealloc {
  self.bar = nil;
  [super dealloc];
}

按照順序釋放資源

在類或者Controller的生命周期結(jié)束時(shí)，往往需要做一些掃尾工作印颤，比如釋放資源您机，停止線程等，這些掃尾工作的釋放順序應(yīng)當(dāng)與它們的初始化或者定義的順序保持一致。這樣做是為了方便調(diào)試時(shí)尋找錯(cuò)誤际看，也能防止遺漏咸产。

保證 NSString 在賦值時(shí)被復(fù)制

在傳遞或者賦值時(shí)應(yīng)當(dāng)保證是以復(fù)制（copy）的方式進(jìn)行的，這樣可以防止在不知情的情況下String的值被其它對(duì)象修改仲闽。

// 使用 copy 而不是 retain或strong 修飾字符串類型
@property (nonatomic, copy) NSString *text;

使用NSNumber的語法糖

使用帶有@符號(hào)的語法糖來生成 NSNumber 對(duì)象能使代碼更簡(jiǎn)潔：

NSNumber *fortyTwo = @42;
NSNumber *piOverTwo = @(M_PI / 2);
enum {
  MyEnum = 2;
};
NSNumber *myEnum = @(kMyEnum);

nil 檢查

因?yàn)樵贠bjective-C中向nil對(duì)象發(fā)送命令是不會(huì)拋出異衬砸纾或者導(dǎo)致崩潰的，只是完全的“什么都不干”赖欣，所以屑彻，只在程序中使用nil來做邏輯上的檢查。

另外顶吮，不要使用諸如nil == Object或者Object == nil的形式來判斷社牲。

推薦：

// 直接判斷
if (!objc) {
    ... 
}

反對(duì)：

//不要使用nil == Object的形式
if (nil == objc) {
    ... 
}

“==” 判斷

建議常量值在表達(dá)式的左側(cè)。

推薦：

if ( constant == var )
if ( NULL == pointer )

反對(duì)：

if ( var == constant )
if ( pointer == NULL )

點(diǎn)語法的使用

不要用點(diǎn)分語法來調(diào)用方法悴了，只用來訪問屬性搏恤。這樣是為了防止代碼可讀性問題。

推薦：

// 使用點(diǎn)分語法訪問屬性
NSString *oldName = myObject.name;
myObject.name = @"Alice";

反對(duì)：

// 不要用點(diǎn)分語法調(diào)用方法
NSArray *array = [NSArray arrayWithObject:@"hello"];
NSUInteger numberOfItems = array.count;
array.release;

Delegate要使用弱引用

一個(gè)類的Delegate對(duì)象通常還引用著類本身让禀，這樣很容易造成引用循環(huán)的問題挑社，所以類的Delegate屬性要設(shè)置為弱引用陨界。

@property (nonatomic, weak) id <ASXXXDelegate> delegate;

單例

如果可能巡揍，請(qǐng)盡量避免使用單例。 如果一定要用菌瘪，請(qǐng)使用一個(gè)線程安全的模式來創(chuàng)建共享的實(shí)例腮敌。對(duì)于 GCD，用 dispatch_once() 函數(shù)就可以俏扩。

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

Categories

我們應(yīng)該要在我們的 category 方法前加上自己的小寫前綴以及下劃線（防止與類本身的方法沖突）糜工，比如- (id)ht_myCategoryMethod。 這種實(shí)踐同樣被蘋果推薦录淡。

pragma mark

#pragma mark是一個(gè)在類內(nèi)部組織代碼并且?guī)椭惴纸M方法實(shí)現(xiàn)的好辦法捌木。
我們建議使用 #pragma mark - 來分離不同功能的代碼。
該語句上下各保留一個(gè)換行嫉戚，這是一個(gè)分割線的效果刨裆。

@implementation ASXXXController

#pragma mark - public

+ (instancetype)playerWithUrl:(NSURL *)url {}
+ (void)play:(NSURL *)url {}

#pragma mark - life cycle

- (void)viewDidLoad {}
- (void)dealloc {}

// 這個(gè)模塊應(yīng)該是對(duì)頁面的一些配置方法（刷新、UI 組件加載等）
#pragma mark - configs

/// 當(dāng)前頁面的唯一刷新方法
- (void)refreshView {}
- (void)preparePlayer {}
- (void)initPlayerView {}

// 當(dāng)前頁面對(duì)相關(guān)接口的調(diào)用模塊
#pragma mark - call api

- (void)callXXXApi {}

// 代理相關(guān)模塊
#pragma mark - delegate

// 具體的某一個(gè)代理
#pragma mark ASXXXDelegate

- (void)controlDidPaused {}
- (void)controlDidStarted {}
- (void)controlDidClose {}

#pragma mark - actions

- (void)longPress:(UILongPressGestureRecognizer *)gesture {}

// 頁面邏輯處理模塊
#pragma mark - logical processing

- (void)showNoWifiToast {}
- (void)saveToAlbum {}

#pragma mark - overide

- (BOOL)prefersStatusBarHidden {}

// 屬性的 set彬檀、get 方法
#pragma mark - properties

- (UIView *)playerView {}
- (void)setUrl:(NSURL *)url {}

@end

屬性的線程安全

定義一個(gè)屬性時(shí)帆啃，編譯器會(huì)自動(dòng)生成線程安全的存取方法（Atomic），但這樣會(huì)大大降低性能窍帝，特別是對(duì)于那些需要頻繁存取的屬性來說努潘，是極大的浪費(fèi)。所以如果定義的屬性不需要線程保護(hù)，記得手動(dòng)添加屬性關(guān)鍵字 nonatomic 來取消編譯器的優(yōu)化疯坤。

設(shè)計(jì)模式

我們應(yīng)該始終對(duì)新技術(shù)保持濃厚的興趣报慕，當(dāng)它成熟且我們已掌握時(shí)，便應(yīng)當(dāng)嘗試應(yīng)用压怠。

ReactiveCocoa+MVVM

ReactiveCocoa+MVVM 模式應(yīng)當(dāng)是讓我們心潮澎湃的一種架構(gòu)模式卖子，但是只有當(dāng)我們現(xiàn)有項(xiàng)目架構(gòu)清晰合理時(shí)才能錦上添花。

參考：ReactiveCocoa 和 MVVM 入門
MVVM With ReactiveCocoa

關(guān)于這個(gè)規(guī)范的未盡事項(xiàng)刑峡，請(qǐng)參考 Apple 的文檔：
Cocoa 編程指南
iOS 應(yīng)用編程指南