前言

Objective-C-Coding-Guidelines-In-Chinese

Objective-C編碼規(guī)范技扼，內(nèi)容來自蘋果沥割、谷歌的文檔翻譯嗽桩，『博愛』的編碼經(jīng)驗和對其它資料的總結(jié)幼驶。
詳情可前往：開源項目『BABaseProject』传透！

Objective-C.jpg

概要

Objective-C是一門面向?qū)ο蟮膭討B(tài)編程語言耘沼，主要用于編寫iOS和Mac應用程序。關(guān)于Objective-C的編碼規(guī)范朱盐，蘋果和谷歌都已經(jīng)有很好的總結(jié)：

• Apple Coding Guidelines for Cocoa
• Google Objective-C Style Guide

本文主要整合了對上述文檔的翻譯群嗤、作者自己的編程經(jīng)驗和其他的相關(guān)資料，為公司總結(jié)出一份通用的編碼規(guī)范兵琳。

代碼格式

使用空格而不是制表符Tab

不要在工程里使用Tab鍵狂秘，使用空格來進行縮進。在Xcode > Preferences > Text Editing將Tab和自動縮進都設(shè)置為4個空格闰围。（Google的標準是使用兩個空格來縮進赃绊，但這里還是推薦使用Xcode默認的設(shè)置。）

每一行的最大長度

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

函數(shù)的書寫

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

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

在-和(void)之間應該有一個空格，第一個大括號{的位置在函數(shù)所在行的末尾忠售，同樣應該有一個空格传惠。（我司的C語言規(guī)范要求是第一個大括號單獨占一行，但考慮到OC較長的函數(shù)名和蘋果SDK代碼的風格稻扬，還是將大括號放在行末卦方。）

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

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

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

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

函數(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];

以下寫法是錯誤的：

//錯誤浇坐，要么寫在一行，要么全部分行
[myObject doFooWith:arg1 name:arg2
              error:arg3];
[myObject doFooWith:arg1
               name:arg2 error:arg3];

//錯誤黔宛，按照':'來對齊睛挚，而不是關(guān)鍵字
[myObject doFooWith:arg1
          name:arg2
          error:arg3];

@public和@private標記符

@public和@private標記符應該以一個空格來進行縮進：

@interface MyClass : NSObject {
 @public
  ...
 @private
  ...
}
@end

協(xié)議（Protocols）

在書寫協(xié)議的時候注意用<>括起來的協(xié)議和類型名之間是沒有空格的淮蜈，比如IPCConnectHandler()<IPCPreconnectorDelegate>,這個規(guī)則適用所有書寫協(xié)議的地方，包括函數(shù)聲明灰蛙、類聲明汞贸、實例變量等等：

@interface MyProtocoledClass : NSObject<NSWindowDelegate> {
 @private
    id<MyFancyDelegate> _delegate;
}

- (void)setDelegate:(id<MyFancyDelegate>)aDelegate;
@end

閉包（Blocks）

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

• 較短的block可以寫在一行內(nèi)锨推。
• 如果分行顯示的話仓洼，block的右括號}應該和調(diào)用block那行代碼的第一個非空字符對齊。
• block內(nèi)的代碼采用4個空格的縮進寂曹。
• 如果block過于龐大哎迄，應該單獨聲明成一個變量來使用回右。
• ^和(之間隆圆，^和{之間都沒有空格，參數(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應該單獨定義成變量使用
void (^largeBlock)(void) = ^{
    // ...
};
[_operationQueue addOperationWithBlock:largeBlock];

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

數(shù)據(jù)結(jié)構(gòu)的語法糖

應該使用可讀性更好的語法糖來構(gòu)造NSArray，NSDictionary等數(shù)據(jù)結(jié)構(gòu)慨默，避免使用冗長的alloc,init方法贩耐。

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

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

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

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

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

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

構(gòu)造字典時，字典的Key和Value與中間的冒號:都要留有一個空格奇钞，多行書寫時澡为，也可以將Value對齊：

//正確，冒號':'前后留有一個空格
NSDictionary *option1 = @{
  NSFontAttributeName : [NSFont fontWithName:@"Helvetica-Bold" size:12],
  NSForegroundColorAttributeName : fontColor
};

//正確景埃，按照Value來對齊
NSDictionary *option2 = @{
  NSFontAttributeName :            [NSFont fontWithName:@"Arial" size:12],
  NSForegroundColorAttributeName : fontColor
};

//錯誤媒至，冒號前應該有一個空格
NSDictionary *wrong = @{
  AKey:       @"b",
  BLongerKey: @"c",
};

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

//錯誤塘慕，在冒號前只能有一個空格，冒號后才可以考慮按照Value對齊
NSDictionary *stillWrong = @{
  AKey       : @"b",
  BLongerKey : @"c",
};

命名規(guī)范

基本原則

清晰

命名應該盡可能的清晰和簡潔蒂胞，但在Objective-C中图呢，清晰比簡潔更重要。由于Xcode強大的自動補全功能骗随，我們不必擔心名稱過長的問題蛤织。

//清晰
insertObject:atIndex:

//不清晰，insert的對象類型和at的位置屬性沒有說明
insert:at:

//清晰
removeObjectAtIndex:

//不清晰鸿染，remove的對象類型沒有說明指蚜，參數(shù)的作用沒有說明
remove:

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

//清晰
destinationSelection
setBackgroundColor:

//不清晰涨椒，不要使用簡寫
destSel
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

一致性

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

使用前綴

如果代碼需要打包成Framework給別的工程使用，或者工程項目非常龐大限佩，需要拆分成不同的模塊葵诈，使用命名前綴是非常有用的。

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

• 可以在為類、協(xié)議徊都、函數(shù)沪斟、常量以及typedef宏命名的時候使用前綴，但注意不要為成員變量或者方法使用前綴暇矫，因為他們本身就包含在類的命名空間內(nèi)主之。

• 命名前綴的時候不要和蘋果SDK框架沖突。

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

類名以大寫字母開頭李根，應該包含一個名詞來表示它代表的對象類型槽奕，同時可以加上必要的前綴，比如NSString, NSDate, NSScanner, NSApplication等等房轿。

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

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

命名頭文件（Headers）

源碼的頭文件名應該清晰地暗示它的功能和包含的內(nèi)容：

• 如果頭文件內(nèi)只定義了單個類或者協(xié)議逊拍，直接用類名或者協(xié)議名來命名頭文件，比如NSLocale.h定義了NSLocale類际邻。

• 如果頭文件內(nèi)定義了一系列的類芯丧、協(xié)議、類別枯怖，使用其中最主要的類名來命名頭文件注整，比如NSString.h定義了NSString和NSMutableString能曾。

• 每一個Framework都應該有一個和框架同名的頭文件度硝，包含了框架中所有公共類頭文件的引用，比如Foundation.h

• Framework中有時候會實現(xiàn)在別的框架中類的類別擴展寿冕，這樣的文件通常使用被擴展的框架名+Additions的方式來命名蕊程，比如NSBundleAdditions.h。

命名方法（Methods）

Objective-C的方法名通常都比較長驼唱，這是為了讓程序有更好地可讀性藻茂，按蘋果的說法“好的方法名應當可以以一個句子的形式朗讀出來”。

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

• 可以用一些通用的大寫字母縮寫打頭方法，比如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)鍵詞應當清晰說明參數(shù)的作用：

//正確贯莺，保證每個參數(shù)都有關(guān)鍵詞修飾
- (void)sendAction:(SEL)aSelector toObject:(id)anObject forAllCells:(BOOL)flag;

//錯誤漓滔，遺漏關(guān)鍵詞
- (void)sendAction:(SEL)aSelector :(id)anObject :(BOOL)flag;

//正確
- (id)viewWithTag:(NSInteger)aTag;

//錯誤，關(guān)鍵詞的作用不清晰
- (id)taggedView:(int)aTag;

不要用and來連接兩個參數(shù)乖篷，通常and用來表示方法執(zhí)行了兩個相對獨立的操作（從設(shè)計上來說响驴，這時候應該拆分成兩個獨立的方法）：

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

//正確撕蔼，使用"and"來表示兩個相對獨立的操作
- (BOOL)openFile:(NSString *)fullPath withApplication:(NSString *)appName andDeactivate:(BOOL)flag;

方法的參數(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

存取方法（Accessor Methods）

存取方法是指用來獲取和設(shè)置類屬性值的方法，屬性的不同類型讼溺，對應著不同的存取方法規(guī)范：

//屬性是一個名詞時的存取方法范式
- (type)noun;
- (void)setNoun:(type)aNoun;
//栗子
- (NSString *)title;
- (void)setTitle:(NSString *)aTitle;

//屬性是一個形容詞時存取方法的范式
- (BOOL)isAdjective;
- (void)setAdjective:(BOOL)flag;
//栗子
- (BOOL)isEditable;
- (void)setEditable:(BOOL)flag;

//屬性是一個動詞時存取方法的范式
- (BOOL)verbObject;
- (void)setVerbObject:(BOOL)flag;
//栗子
- (BOOL)showsAlpha;
- (void)setShowsAlpha:(BOOL)flag;

命名存取方法時不要將動詞轉(zhuǎn)化為被動形式來使用：

//正確
- (void)setAcceptsGlyphInfo:(BOOL)flag;
- (BOOL)acceptsGlyphInfo;

//錯誤楣号，不要使用動詞的被動形式
- (void)setGlyphInfoAccepted:(BOOL)flag;
- (BOOL)glyphInfoAccepted;

可以使用can,should,will等詞來協(xié)助表達存取方法的意思，但不要使用do,和does：

//正確
- (void)setCanHide:(BOOL)flag;
- (BOOL)canHide;
- (void)setShouldCloseDocument:(BOOL)flag;
- (BOOL)shouldCloseDocument;

//錯誤怒坯，不要使用"do"或者"does"
- (void)setDoesAcceptGlyphInfo:(BOOL)flag;
- (BOOL)doesAcceptGlyphInfo;

為什么Objective-C中不適用get前綴來表示屬性獲取方法炫狱？因為get在Objective-C中通常只用來表示從函數(shù)指針返回值的函數(shù)：

//三個參數(shù)都是作為函數(shù)的返回值來使用的，這樣的函數(shù)名可以使用"get"前綴
- (void)getLineDash:(float *)pattern count:(int *)count phase:(float *)phase;

命名委托（Delegate）

當特定的事件發(fā)生時剔猿，對象會觸發(fā)它注冊的委托方法视译。委托是Objective-C中常用的傳遞消息的方式。委托有它固定的命名范式归敬。

一個委托方法的第一個參數(shù)是觸發(fā)它的對象酷含，第一個關(guān)鍵詞是觸發(fā)對象的類名鄙早，除非委托方法只有一個名為sender的參數(shù)：

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

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

根據(jù)委托方法觸發(fā)的時機和目的，使用should,will,did等關(guān)鍵詞

- (void)browserDidScroll:(NSBrowser *)sender;

- (NSUndoManager *)windowWillReturnUndoManager:(NSWindow *)window;椅亚、

- (BOOL)windowShouldClose:(id)sender;

集合操作類方法（Collection Methods）

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

//集合操作范式
- (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;

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

下面是SDK中NSWindow類的集合操作方法：

- (void)addChildWindow:(NSWindow *)childWin ordered:(NSWindowOrderingMode)place;
- (void)removeChildWindow:(NSWindow *)childWin;
- (NSArray *)childWindows;
- (NSWindow *)parentWindow;
- (void)setParentWindow:(NSWindow *)window;

命名函數(shù)（Functions）

在很多場合仍然需要用到函數(shù)省古，比如說如果一個對象是一個單例粥庄，那么應該使用函數(shù)來代替類方法執(zhí)行相關(guān)操作。

函數(shù)的命名和方法有一些不同豺妓，主要是：

• 函數(shù)名稱一般帶有縮寫前綴惜互，表示方法所在的框架。
• 前綴后的單詞以“駝峰”表示法顯示琳拭，第一個單詞首字母大寫训堆。

函數(shù)名的第一個單詞通常是一個動詞，表示方法執(zhí)行的操作：

NSHighlightRect
NSDeallocateObject

如果函數(shù)返回其參數(shù)的某個屬性白嘁，省略動詞：

unsigned int NSEventMaskFromType(NSEventType type)
float NSHeight(NSRect aRect)

如果函數(shù)通過指針參數(shù)來返回值坑鱼，需要在函數(shù)名中使用Get：

const char *NSGetSizeAndAlignment(const char *typePtr, unsigned int *sizep, unsigned int *alignp)

函數(shù)的返回類型是BOOL時的命名：

BOOL NSDecimalIsNotANumber(const NSDecimal *decimal)

命名屬性和實例變量（Properties&Instance Variables）

屬性和對象的存取方法相關(guān)聯(lián)，屬性的第一個字母小寫絮缅，后續(xù)單詞首字母大寫鲁沥，不必添加前綴。屬性按功能命名成名詞或者動詞：

//名詞屬性
@property (strong) NSString *title;

//動詞屬性
@property (assign) BOOL showsAlpha;

屬性也可以命名成形容詞耕魄，這時候通常會指定一個帶有is前綴的get方法來提高可讀性：

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

命名實例變量画恰，在變量名前加上_前綴（有些有歷史的代碼會將_放在后面），其它和命名屬性一樣：

@implementation MyClass {
    BOOL _showsTitle;
}

一般來說吸奴，類需要對使用者隱藏數(shù)據(jù)存儲的細節(jié)允扇，所以不要將實例方法定義成公共可訪問的接口，可以使用@private则奥，@protected前綴考润。

按蘋果的說法，不建議在除了init和dealloc方法以外的地方直接訪問實例變量逞度，但很多人認為直接訪問會讓代碼更加清晰可讀额划，只在需要計算或者執(zhí)行操作的時候才使用存取方法訪問，我就是這種習慣档泽，所以這里不作要求俊戳。

命名常量（Constants）

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

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

定義bit map：

typedef NS_OPTIONS(NSUInteger, NSWindowMask) {
    NSBorderlessWindowMask      = 0,
    NSTitledWindowMask          = 1 << 0,
    NSClosableWindowMask        = 1 << 1,
    NSMiniaturizableWindowMask  = 1 << 2,
    NSResizableWindowMask       = 1 << 3
};

使用const定義浮點型或者單個的整數(shù)型常量渐北，如果要定義一組相關(guān)的整數(shù)常量阿逃，應該優(yōu)先使用枚舉。常量的命名規(guī)范和函數(shù)相同：

const float NSLightGray;

不要使用#define宏來定義常量赃蛛，如果是整型常量恃锉，盡量使用枚舉，浮點型常量呕臂，使用const定義破托。#define通常用來給編譯器決定是否編譯某塊代碼，比如常用的：

#ifdef DEBUG

注意到一般由編譯器定義的宏會在前后都有一個__歧蒋，比如__MACH__土砂。

命名通知（Notifications）

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

[觸發(fā)通知的類名] + [Did | Will] + [動作] + Notification

栗子：

NSApplicationDidBecomeActiveNotification
NSWindowDidMiniaturizeNotification
NSTextViewDidChangeSelectionNotification
NSColorPanelColorDidChangeNotification

注釋

讀沒有注釋代碼的痛苦你我都體會過萝映，好的注釋不僅能讓人輕松讀懂你的程序，還能提升代碼的逼格阐虚。注意注釋是為了讓別人看懂序臂，而不是僅僅你自己。

文件注釋

每一個文件都必須寫文件注釋实束，文件注釋通常包含

• 文件所在模塊
• 作者信息
• 歷史版本信息
• 版權(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.

********************************************************************************/

文件注釋的格式通常不作要求，能清晰易讀就可以了磕洪，但在整個工程中風格要統(tǒng)一吭练。

代碼注釋

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

方法谷异、函數(shù)分尸、類、協(xié)議歹嘹、類別的定義都需要注釋箩绍，推薦采用Apple的標準注釋風格，好處是可以在引用的地方alt+點擊自動彈出注釋尺上，非常方便材蛛。

有很多可以自動生成注釋格式的插件圆到，推薦使用VVDocumenter：

Screenshot

一些良好的注釋：

/**
 *  Create a new preconnector to replace the old one with given mac address.
 *  NOTICE: We DO NOT stop the old preconnector, so handle it by yourself.
 *
 *  @param type       Connect type the preconnector use.
 *  @param macAddress Preconnector's mac address.
 */
- (void)refreshConnectorWithConnectType:(IPCConnectType)type  Mac:(NSString *)macAddress;

/**
 *  Stop current preconnecting when application is going to background.
 */
-(void)stopRunning;

/**
 *  Get the COPY of cloud device with a given mac address.
 *
 *  @param macAddress Mac address of the device.
 *
 *  @return Instance of IPCCloudDevice.
 */
-(IPCCloudDevice *)getCloudDeviceWithMac:(NSString *)macAddress;

// A delegate for NSApplication to handle notifications about app
// launch and shutdown. Owned by the main app controller.
@interface MyAppDelegate : NSObject {
  ...
}
@end

協(xié)議、委托的注釋要明確說明其被觸發(fā)的條件：

/** Delegate - Sent when failed to init connection, like p2p failed. */
-(void)initConnectionDidFailed:(IPCConnectHandler *)handler;

如果在注釋中要引用參數(shù)名或者方法函數(shù)名卑吭，使用||將參數(shù)或者方法括起來以避免歧義：

// Sometimes we need |count| to be less than zero.

// Remember to call |StringWithoutSpaces("foo bar baz")|

定義在頭文件里的接口方法芽淡、屬性必須要有注釋！

編碼風格

每個人都有自己的編碼風格豆赏，這里總結(jié)了一些比較好的Cocoa編程風格和注意點挣菲。

不要使用new方法

盡管很多時候能用new代替alloc init方法，但這可能會導致調(diào)試內(nèi)存時出現(xiàn)不可預料的問題掷邦。Cocoa的規(guī)范就是使用alloc init方法白胀，使用new會讓一些讀者困惑。

Public API要盡量簡潔

共有接口要設(shè)計的簡潔抚岗，滿足核心的功能需求就可以了或杠。不要設(shè)計很少會被用到，但是參數(shù)極其復雜的API苟跪。如果要定義復雜的方法廷痘，使用類別或者類擴展。

#import和#include

#import是Cocoa中常用的引用頭文件的方式件已，它能自動防止重復引用文件笋额，什么時候使用#import，什么時候使用#include呢篷扩？

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

栗子：

#import <Cocoa/Cocoa.h>
#include <CoreFoundation/CoreFoundation.h>
#import "GTMFoo.h"
#include "base/basictypes.h"

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

引用框架的根頭文件

上面提到過淹真，每一個框架都會有一個和框架同名的頭文件，它包含了框架內(nèi)接口的所有引用连茧，在使用框架的時候核蘸，應該直接引用這個根頭文件，而不是其它子模塊的頭文件啸驯，即使是你只用到了其中的一小部分客扎，編譯器會自動完成優(yōu)化的。

//正確罚斗，引用根頭文件
#import <Foundation/Foundation.h>

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

BOOL的使用

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

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

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

同樣的，也不要將其它類型的值作為BOOL來返回杆故，這種情況下迅箩，BOOL變量只會取值的最后一個字節(jié)來賦值溉愁，這樣很可能會取到0（NO）处铛。但是，一些邏輯操作符比如&&,||,!的返回是可以直接賦給BOOL的：

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

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

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

另外BOOL類型可以和_Bool,bool相互轉(zhuǎn)化，但是不能和Boolean轉(zhuǎn)化堂污。

使用ARC

除非想要兼容一些古董級的機器和操作系統(tǒng)家肯，我們沒有理由放棄使用ARC。在最新版的Xcode(6.2)中盟猖，ARC是自動打開的讨衣，所以直接使用就好了。

在init和dealloc中不要用存取方法訪問實例變量

當init``dealloc方法被執(zhí)行時式镐，類的運行時環(huán)境不是處于正常狀態(tài)的反镇，使用存取方法訪問變量可能會導致不可預料的結(jié)果，因此應當在這兩個方法內(nèi)直接訪問實例變量娘汞。

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

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

按照定義的順序釋放資源

在類或者Controller的生命周期結(jié)束時你弦，往往需要做一些掃尾工作惊豺，比如釋放資源，停止線程等禽作，這些掃尾工作的釋放順序應當與它們的初始化或者定義的順序保持一致尸昧。這樣做是為了方便調(diào)試時尋找錯誤，也能防止遺漏旷偿。

保證NSString在賦值時被復制

NSString非常常用烹俗，在它被傳遞或者賦值時應當保證是以復制（copy）的方式進行的，這樣可以防止在不知情的情況下String的值被其它對象修改狸捅。

- (void)setFoo:(NSString *)aFoo {
  _foo = [aFoo copy];
}

使用NSNumber的語法糖

使用帶有@符號的語法糖來生成NSNumber對象能使代碼更簡潔：

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

nil檢查

因為在Objective-C中向nil對象發(fā)送命令是不會拋出異持则眩或者導致崩潰的，只是完全的“什么都不干”尘喝，所以磁浇，只在程序中使用nil來做邏輯上的檢查。

另外朽褪，不要使用諸如nil == Object或者Object == nil的形式來判斷置吓。

//正確无虚，直接判斷
if (!objc) {
    ...
}

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

屬性的線程安全

定義一個屬性時衍锚，編譯器會自動生成線程安全的存取方法（Atomic）友题，但這樣會大大降低性能，特別是對于那些需要頻繁存取的屬性來說戴质，是極大的浪費度宦。所以如果定義的屬性不需要線程保護，記得手動添加屬性關(guān)鍵字nonatomic來取消編譯器的優(yōu)化告匠。

點分語法的使用

不要用點分語法來調(diào)用方法戈抄，只用來訪問屬性。這樣是為了防止代碼可讀性問題后专。

//正確划鸽，使用點分語法訪問屬性
NSString *oldName = myObject.name;
myObject.name = @"Alice";

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

Delegate要使用弱引用

一個類的Delegate對象通常還引用著類本身戚哎，這樣很容易造成引用循環(huán)的問題裸诽，所以類的Delegate屬性要設(shè)置為弱引用。

/** delegate */
@property (nonatomic, weak) id <IPCConnectHandlerDelegate> delegate;