Objective-C 編碼規(guī)范，內(nèi)容來自蘋果的文檔翻譯，自己的編碼經(jīng)驗和對其它資料的總結(jié)。

一.命名規(guī)范

基本原則

1.清晰
命名應(yīng)該盡可能的清晰和簡潔，但在 Objective-C 中，清晰比簡潔更重要。由于 Xcode 強大的自動補全功能，我們不必擔心名稱過長的問題。

// 清晰
insertObject:atIndex:
// 不清晰， insert 的對象類型和 at 的位置屬性沒有說明
insert:at:
// 清晰
removeObjectAtIndex:
// 不清晰， remove 的對象類型沒有說明，參數(shù)的作用沒有說明
remove:

不要使用單詞的簡寫，拼寫出完整的單詞：

// 清晰
setBackgroundColor:
// 不清晰，不要使用簡寫
setBkgdColor:

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

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ù)時要避免歧義
功能的英文詞義命名， 以它[做什么]來命名，而不是[怎么做]來命名

// 有歧義，是返回 sendPort 還是 send 一個 Port ？
sendPort
// 有歧義，是返回一個名字屬性的值還是 display 一個 name 的動作？
displayName

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

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

• 如果代碼需要打包成 Framework 給別的工程使用，或者工程項目非常龐大，需要拆分成不同的模塊，使用命名前綴是非常有用的。
• 可以在為類、協(xié)議、函數(shù)、常量以及 typedef 宏命名的時候使用前綴，但注意不要為成員變量或者方法使用前綴，因為他們本身就包含在類的命名空間內(nèi)。
• 命名前綴的時候不要和蘋果 SDK 框架沖突

前綴由大寫的字母縮寫組成，比如 Cocoa 中 NS 前綴代表 Founation 框架中的類， IB 則代表 Interface Builder 框架。

所以要選擇符合自己項目的前綴,

執(zhí)行準則

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

• 類名以大寫字母開頭，應(yīng)該包含一個名詞來表示它代表的對象類型，同時可以加上必要的前綴，比如 NSString,NSDate,NSScanner,NSApplication 等等。

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

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

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

• 如果頭文件內(nèi)只定義了單個類或者協(xié)議，直接用類名或者協(xié)議名來命名頭文件，比如 NSLocale.h 定義了 NSLocale 類。
• 如果頭文件內(nèi)定義了一系列的類、協(xié)議、類別，使用其中最主要的類名來命名頭文件，比如 NSString.h 定義了 NSString 和 NSMutableString 。
• 每一個 Framework 都應(yīng)該有一個和框架同名的頭文件，包含了框架中所有公共類頭文件的引用，比如 Foundation.h
• Framework 中有時候會實現(xiàn)在別的框架中類的類別擴展，這樣的文件通常使用被擴展的框架名 +Additions 的方式來命名，比如 NSBundleAdditions.h 。

3.命名方法（ Methods ）
Objective-C 的方法名通常都比較長，這是為了讓程序有更好地可讀性，按蘋果的說法 “_ 好的方法名應(yīng)當可以以一個句子的形式朗讀出來_ ” 。

方法一般以小寫字母打頭，每一個后續(xù)的單詞首字母大寫，方法名中不應(yīng)該有標點符號（包括下劃線），有兩個例外：

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

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

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

如果方法是為了獲取對象的一個屬性值，直接用屬性名稱來命名這個方法，注意不要添加 get 或者其他的動詞前綴：

// 正確，使用屬性名來命名方法
- (NSSize)cellSize;
// 錯誤，添加了多余的動詞前綴
- (NSSize)calcCellSize;
- (NSSize)getCellSize;

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

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

• 和方法名類似，參數(shù)的第一個字母小寫，后面的每一個單詞首字母大寫
• 不要再方法名中使用類似 pointer,ptr 這樣的字眼去表示指針，參數(shù)本身的類型足以說明
• 不要使用只有一兩個字母的參數(shù)名
• 不要使用簡寫，拼出完整的單詞

下面列舉了一些常用參數(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)的常量，盡量使用枚舉類型（ enumerations ），枚舉類型的命名規(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,
};

枚舉也要選取適合自己項目的前綴

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

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

kNotificationMessageDidSendFail

6.文件注釋
每一個文件都必須寫文件注釋，文件注釋通常包含:

• 作者信息
• 文件包含的內(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對象
 */

8.import 和 include

import 是 Cocoa 中常用的引用頭文件的方式，它能自動防止重復(fù)引用文件，什么時候使用 import ，什么時候使用 include 呢？

• 當引用的是一個 Objective-C 或者 Objective-C++ 的頭文件時，使用 import
• 當引用的是一個 C 或者 C++ 的頭文件時，使用 include ，這時必須要保證被引用的文件提供了保護域（ define guard ）。

二.代碼格式

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

在 Xcode > Preferences > Text Editing 將 Tab 和自動縮進都設(shè)置為 4 個空格。

2.每一行的最大長度

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

3.函數(shù)的書寫

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

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

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

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

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

在分行時，如果第一段名稱過短，后續(xù)名稱可以以 Tab 的長度（ 4 個空格）為單位進行縮進：

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

4.函數(shù)調(diào)用
函數(shù)調(diào)用的格式和書寫差不多，可以按照函數(shù)的長短來選擇寫在一行或者分成多行：

// 寫在一行
[myObject doFooWith:arg1 name:arg2 error:arg3];
// 分行寫，按照 ':' 對齊
[myObject doFooWith:arg1
               name:arg2
              error:arg3];
// 第一段名稱過短的話后續(xù)可以進行縮進
[myObj short:arg1
 longKeyword:arg2
evenLongerKeyword:arg3
        error:arg4];

5.閉包（ Blocks ）

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

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

// 較長的 block 關(guān)鍵字可以縮進后在新行書寫，注意 block 的右括號 '}' 和調(diào)用 block 那行代碼的第一個非空字符對齊
[[SessionService sharedService]
loadWindowWithCompletionBlock:^(SessionWindow *window) {
    if (window) {
        [self windowDidLoad:window];
    } else {
        [self errorLoadingWindow];
    }
}];
// 較長的 block 參數(shù)列表同樣可以縮進后在新行書寫
[[SessionService sharedService]
loadWindowWithCompletionBlock:
^(SessionWindow *window) {
    if (window) {
        [self windowDidLoad:window];
    } else {
        [self errorLoadingWindow];
    }
}];

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

三.代碼組織

在函數(shù)分組和protocol/delegate實現(xiàn)中使用#pragma mark -來分類方法，要遵循以下一般結(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 {}