Objective-C 編碼規(guī)范狂秦，內(nèi)容來(lái)自蘋(píng)果的文檔翻譯，自己的編碼經(jīng)驗(yàn)和對(duì)其它資料的總結(jié)浑塞。

一.命名規(guī)范

基本原則

1.清晰
命名應(yīng)該盡可能的清晰和簡(jiǎn)潔关筒，但在 Objective-C 中，清晰比簡(jiǎn)潔更重要驶睦。由于 Xcode 強(qiáng)大的自動(dòng)補(bǔ)全功能砰左，我們不必?fù)?dān)心名稱(chēng)過(guò)長(zhǎng)的問(wèn)題。

// 清晰
insertObject:atIndex:
// 不清晰场航， insert 的對(duì)象類(lèi)型和 at 的位置屬性沒(méi)有說(shuō)明
insert:at:
// 清晰
removeObjectAtIndex:
// 不清晰缠导， remove 的對(duì)象類(lèi)型沒(méi)有說(shuō)明，參數(shù)的作用沒(méi)有說(shuō)明
remove:

不要使用單詞的簡(jiǎn)寫(xiě)溉痢，拼寫(xiě)出完整的單詞：

// 清晰
setBackgroundColor:
// 不清晰僻造，不要使用簡(jiǎn)寫(xiě)
setBkgdColor:

然而，有部分單詞簡(jiǎn)寫(xiě)在 Objective-C 編碼過(guò)程中是非常常用的适室，以至于成為了一種規(guī)范嫡意，這些簡(jiǎn)寫(xiě)可以在代碼中直接使用，下面列舉了部分

alloc == Allocate 
max == Maximum
alt == Alternate 
min == Minimum
app == Application 
msg == Message
calc == Calculate 
nib == Interface Builder archive
dealloc == Deallocate 
pboard == Pasteboard
func == Function 
rect == Rectangle
horiz == Horizontal 
Rep == Representation (used in class name such as NSBitmapImageRep).
info == Information 
temp == Temporary
init == Initialize 
vert == Vertical
int == Integer

命名方法或者函數(shù)時(shí)要避免歧義
功能的英文詞義命名捣辆， 以它[做什么]來(lái)命名蔬螟，而不是[怎么做]來(lái)命名

// 有歧義，是返回 sendPort 還是 send 一個(gè) Port 汽畴？
sendPort
// 有歧義旧巾，是返回一個(gè)名字屬性的值還是 display 一個(gè) name 的動(dòng)作？
displayName

// 正確 很明顯這個(gè)函數(shù)是返回一個(gè)消息的時(shí)間戳
getAmsgTimeStamp;

2.一致性
整個(gè)工程的命名風(fēng)格要保持一致性忍些，最好和蘋(píng)果 SDK 的代碼保持統(tǒng)一鲁猩。不同類(lèi)中完成相似功能的方法應(yīng)該叫一樣的名字，比如我們總是用 count 來(lái)返回集合的個(gè)數(shù)罢坝，不能在 A 類(lèi)中使用 count 而在 B 類(lèi)中使用 getNumber 廓握。

• 如果代碼需要打包成 Framework 給別的工程使用，或者工程項(xiàng)目非常龐大，需要拆分成不同的模塊隙券，使用命名前綴是非常有用的男应。
• 可以在為類(lèi)、協(xié)議娱仔、函數(shù)沐飘、常量以及 typedef 宏命名的時(shí)候使用前綴，但注意不要為成員變量或者方法使用前綴牲迫，因?yàn)樗麄儽旧砭桶陬?lèi)的命名空間內(nèi)耐朴。
• 命名前綴的時(shí)候不要和蘋(píng)果 SDK 框架沖突

前綴由大寫(xiě)的字母縮寫(xiě)組成，比如 Cocoa 中 NS 前綴代表 Founation 框架中的類(lèi)盹憎， IB 則代表 Interface Builder 框架筛峭。

所以要選擇符合自己項(xiàng)目的前綴,

執(zhí)行準(zhǔn)則

1.命名類(lèi)和協(xié)議（ Class&Protocol ）

• 類(lèi)名以大寫(xiě)字母開(kāi)頭，應(yīng)該包含一個(gè)名詞來(lái)表示它代表的對(duì)象類(lèi)型脚乡，同時(shí)可以加上必要的前綴蜒滩，比如 NSString,NSDate,NSScanner,NSApplication 等等。

• 協(xié)議名稱(chēng)應(yīng)該清晰地表示它所執(zhí)行的行為奶稠，而且要和類(lèi)名區(qū)別開(kāi)來(lái)俯艰，所以通常使用 ing 詞尾來(lái)命名一個(gè)協(xié)議，比如 NSCopying,NSLocking 锌订。

• 有些協(xié)議本身包含了很多不相關(guān)的功能竹握，主要用來(lái)為某一特定類(lèi)服務(wù)，這時(shí)候可以直接用類(lèi)名來(lái)命名這個(gè)協(xié)議辆飘，比如 NSObject 協(xié)議啦辐，它包含了 id 對(duì)象在生存周期內(nèi)的一系列方法。

2.命名頭文件（ Headers ）
源碼的頭文件名應(yīng)該清晰地暗示它的功能和包含的內(nèi)容：

• 如果頭文件內(nèi)只定義了單個(gè)類(lèi)或者協(xié)議蜈项，直接用類(lèi)名或者協(xié)議名來(lái)命名頭文件芹关，比如 NSLocale.h 定義了 NSLocale 類(lèi)。
• 如果頭文件內(nèi)定義了一系列的類(lèi)紧卒、協(xié)議侥衬、類(lèi)別，使用其中最主要的類(lèi)名來(lái)命名頭文件跑芳，比如 NSString.h 定義了 NSString 和 NSMutableString 轴总。
• 每一個(gè) Framework 都應(yīng)該有一個(gè)和框架同名的頭文件，包含了框架中所有公共類(lèi)頭文件的引用博个，比如 Foundation.h
• Framework 中有時(shí)候會(huì)實(shí)現(xiàn)在別的框架中類(lèi)的類(lèi)別擴(kuò)展怀樟，這樣的文件通常使用被擴(kuò)展的框架名 +Additions 的方式來(lái)命名，比如 NSBundleAdditions.h 盆佣。

3.命名方法（ Methods ）
Objective-C 的方法名通常都比較長(zhǎng)往堡，這是為了讓程序有更好地可讀性械荷，按蘋(píng)果的說(shuō)法 “_ 好的方法名應(yīng)當(dāng)可以以一個(gè)句子的形式朗讀出來(lái)_ ” 。

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

• 可以用一些通用的大寫(xiě)字母縮寫(xiě)打頭方法瘩缆，比如 PDF,TIFF 等。
• 可以用帶下劃線的前綴來(lái)命名私有方法或者類(lèi)別中的方法佃蚜。

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

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

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

// 正確斤儿，使用屬性名來(lái)命名方法
- (NSSize)cellSize;
// 錯(cuò)誤，添加了多余的動(dòng)詞前綴
- (NSSize)calcCellSize;
- (NSSize)getCellSize;

對(duì)于有多個(gè)參數(shù)的方法恐锦，務(wù)必在每一個(gè)參數(shù)前都添加關(guān)鍵詞往果，關(guān)鍵詞應(yīng)當(dāng)清晰說(shuō)明參數(shù)的作用不要用 and 來(lái)連接兩個(gè)參數(shù)，通常 and 用來(lái)表示方法執(zhí)行了兩個(gè)相對(duì)獨(dú)立的操作（從設(shè)計(jì)上來(lái)說(shuō)一铅，這時(shí)候應(yīng)該拆分成兩個(gè)獨(dú)立的方法）.

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

• 和方法名類(lèi)似陕贮，參數(shù)的第一個(gè)字母小寫(xiě)，后面的每一個(gè)單詞首字母大寫(xiě)
• 不要再方法名中使用類(lèi)似 pointer,ptr 這樣的字眼去表示指針潘飘，參數(shù)本身的類(lèi)型足以說(shuō)明
• 不要使用只有一兩個(gè)字母的參數(shù)名
• 不要使用簡(jiǎn)寫(xiě)肮之，拼出完整的單詞

下面列舉了一些常用參數(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

4.命名常量（ Constants ）

如果要定義一組相關(guān)的常量，盡量使用枚舉類(lèi)型（ enumerations ）卜录，枚舉類(lèi)型的命名規(guī)則和函數(shù)的命名規(guī)則相同：

//下拉刷新
typedef enum{
    HWRefreshStatuPulling           = 0,//下拉
    HWRefreshStatuRefrshing         = 1,//刷新
    HWRefreshStatuFinish            = 2//刷新完成
}HWRefreshStatus;

//這是SDWebImage的枚舉
typedef NS_OPTIONS(NSUInteger, SDWebImageDownloaderOptions) {
    SDWebImageDownloaderLowPriority = 1 << 0,
    SDWebImageDownloaderProgressiveDownload = 1 << 1,

    /**
     * By default, request prevent the of NSURLCache. With this flag, NSURLCache
     * is used with default policies.
     */
    SDWebImageDownloaderUseNSURLCache = 1 << 2,

    /**
     * Call completion block with nil image/imageData if the image was read from NSURLCache
     * (to be combined with `SDWebImageDownloaderUseNSURLCache`).
     */

    SDWebImageDownloaderIgnoreCachedResponse = 1 << 3,
    /**
     * In iOS 4+, continue the download of the image if the app goes to background. This is achieved by asking the system for
     * extra time in background to let the request finish. If the background task expires the operation will be cancelled.
     */

    SDWebImageDownloaderContinueInBackground = 1 << 4,

    /**
     * Handles cookies stored in NSHTTPCookieStore by setting 
     * NSMutableURLRequest.HTTPShouldHandleCookies = YES;
     */
    SDWebImageDownloaderHandleCookies = 1 << 5,

    /**
     * Enable to allow untrusted SSL ceriticates.
     * Useful for testing purposes. Use with caution in production.
     */
    SDWebImageDownloaderAllowInvalidSSLCertificates = 1 << 6,

    /**
     * Put the image in the high priority queue.
     */
    SDWebImageDownloaderHighPriority = 1 << 7,
};

枚舉也要選取適合自己項(xiàng)目的前綴

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

[ k ] + Notification + [ 動(dòng)作 ] + [Did | Will] + [ 狀態(tài) ]

kNotificationMessageDidSendFail

6.文件注釋
每一個(gè)文件都必須寫(xiě)文件注釋?zhuān)募⑨屚ǔ０?

• 作者信息
• 文件包含的內(nèi)容艰毒，作用
• 歷史版本
• 文件所在模塊

/*******************************************************************************
 Author: Sean Xue (Xue yunqiang)
 E-mail: x402399587@163.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"
 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
 ********************************************************************************/

//
//  ViewController.m
//  LRMacroDefinition
//
//  Created by lu on 16/7/4.
//  Copyright ? 2016年 scorpio. All rights reserved.
//

7.代碼注釋

按住Command+Option+/即可得到

/**
 <#Description#>

 @param imageName <#imageName description#>
 @return <#return value description#>
 */

依次注釋即可

//代碼樣式舉例
/**
 輸入圖片名獲取圖片

 @param imageName 圖片名成
 @return UIImage對(duì)象
 */

8.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 ）。

二.代碼格式

1.將空格設(shè)置為四個(gè)空格

在 Xcode > Preferences > Text Editing 將 Tab 和自動(dòng)縮進(jìn)都設(shè)置為 4 個(gè)空格灸促。

2.每一行的最大長(zhǎng)度

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

3.函數(shù)的書(shū)寫(xiě)

一個(gè)典型的 Objective-C 函數(shù)應(yīng)該是這樣的：

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

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

如果一個(gè)函數(shù)有特別多的參數(shù)或者名稱(chēng)很長(zhǎng)被廓，應(yīng)該將其按照 : 來(lái)對(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)delegate;

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

    - (void)short:(int)theFoo
      longKeyword:(NSRect)theRect
evenLongerKeyword:(float)theInterval
            error:(NSError **)theError;

4.函數(shù)調(diào)用
函數(shù)調(diào)用的格式和書(shū)寫(xiě)差不多嫁乘，可以按照函數(shù)的長(zhǎng)短來(lái)選擇寫(xiě)在一行或者分成多行：

// 寫(xiě)在一行
[myObject doFooWith:arg1 name:arg2 error:arg3];
// 分行寫(xiě)昆婿，按照 ':' 對(duì)齊
[myObject doFooWith:arg1
               name:arg2
              error:arg3];
// 第一段名稱(chēng)過(guò)短的話后續(xù)可以進(jìn)行縮進(jìn)
[myObj short:arg1
 longKeyword:arg2
evenLongerKeyword:arg3
        error:arg4];

5.閉包（ Blocks ）

• 較短的 block 可以寫(xiě)在一行內(nèi)。
• 如果分行顯示的話蜓斧， block 的右括號(hào) } 應(yīng)該和調(diào)用 block 那行代碼的第* 一個(gè)非空字符對(duì)齊仓蛆。
• block 內(nèi)的代碼采用 4 個(gè)空格 的縮進(jìn)。
• 如果 block 過(guò)于龐大挎春，應(yīng)該單獨(dú)聲明成一個(gè)變量來(lái)使用看疙。
• ^ 和 ( 之間， ^ 和 { 之間都沒(méi)有空格直奋，參數(shù)列表的右括號(hào) ) 和 { 之間有一個(gè)空格能庆。

// 較短的 block 寫(xiě)在一行內(nèi)
[operation setCompletionBlock:^{ [self onOperationDone]; }];
// 分行書(shū)寫(xiě)的 block ，內(nèi)部使用 4 空格縮進(jìn)
[operation setCompletionBlock:^{
    [self.delegate newDataAvailable];
}];
// 使用 C 語(yǔ)言 API 調(diào)用的 block 遵循同樣的書(shū)寫(xiě)規(guī)則
dispatch_async(_fileIOQueue, ^{
    NSString* path = [self sessionFilePath];
    if (path) {
        // ...
    }
});

// 較長(zhǎng)的 block 關(guān)鍵字可以縮進(jìn)后在新行書(shū)寫(xiě)帮碰，注意 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)后在新行書(shū)寫(xiě)
[[SessionService sharedService]
loadWindowWithCompletionBlock:
^(SessionWindow *window) {
    if (window) {
        [self windowDidLoad:window];
    } else {
        [self errorLoadingWindow];
    }
}];

// 龐大的 block 應(yīng)該單獨(dú)定義成變量使用
void (^largeBlock)(void) = ^{
    // ...
};
[_operationQueue addOperationWithBlock:largeBlock];
// 在一個(gè)調(diào)用中使用多個(gè) block 相味，注意到他們不是像函數(shù)那樣通過(guò) ':' 對(duì)齊的，而是同時(shí)進(jìn)行了 4 個(gè)空格的縮進(jìn)
[myObject doSomethingWith:arg1
firstBlock:^(Foo *a) {
    // ...
}
secondBlock:^(Bar *b) {
    // ...
}];

三.代碼組織

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

#pragma mark - Lifecycle

- (instancetype)init {}
- (void)dealloc {}
- (void)viewDidLoad {}
- (void)viewWillAppear:(BOOL)animated {}
- (void)didReceiveMemoryWarning {}

#pragma mark - Public

- (void)publicMethod {}

#pragma mark - Private

- (void)privateMethod {}

#pragma mark - NSCopying

- (id)copyWithZone:(NSZone *)zone {}

#pragma mark - NSObject

- (NSString *)description {}