規範

Objective-C編碼規範，內容來自蘋果、谷歌的文檔翻譯，本身的編碼經驗和對其它資料的總結。

轉載請註明出處。

概要

Objective-C是一門面向對象的動態編程語言，主要用於編寫iOS和Mac應用程序。關於Objective-C的編碼規範，蘋果和谷歌都已經有很好的總結：

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

本文主要整合了對上述文檔的翻譯、做者本身的編程經驗和其餘的相關資料，爲公司總結出一份通用的編碼規範。

代碼格式

使用空格而不是製表符Tab

不要在工程裏使用Tab鍵，使用空格來進行縮進。在Xcode > Preferences > Text Editing將Tab和自動縮進都設置爲4個空格。（Google的標準是使用兩個空格來縮進，但這裏仍是推薦使用Xcode默認的設置。）

每一行的最大長度

一樣的，在Xcode > Preferences > Text Editing > Page guide at column:中將最大行長設置爲80，過長的一行代碼將會致使可讀性問題。

函數的書寫

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

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

在-和(void)之間應該有一個空格，第一個大括號{的位置在函數所在行的末尾，一樣應該有一個空格。（我司的C語言規範要求是第一個大括號單獨佔一行，但考慮到OC較長的函數名和蘋果SDK代碼的風格，仍是將大括號放在行末。）

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

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

在分行時，若是第一段名稱太短，後續名稱能夠以Tab的長度（4個空格）爲單位進行縮進：

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

函數調用

函數調用的格式和書寫差很少，能夠按照函數的長短來選擇寫在一行或者分紅多行：

//寫在一行
[myObject doFooWith:arg1 name:arg2 error:arg3]; //分行寫，按照':'對齊 [myObject doFooWith:arg1 name:arg2 error:arg3]; //第一段名稱太短的話後續能夠進行縮進 [myObj short:arg1 longKeyword:arg2 evenLongerKeyword:arg3 error:arg4];

如下寫法是錯誤的：

//錯誤，要麼寫在一行，要麼所有分行
[myObject doFooWith:arg1 name:arg2 error:arg3]; [myObject doFooWith:arg1 name:arg2 error:arg3]; //錯誤，按照':'來對齊，而不是關鍵字 [myObject doFooWith:arg1 name:arg2 error:arg3];

@public和@private標記符

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

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

協議（Protocols）

在書寫協議的時候注意用<>括起來的協議和類型名之間是沒有空格的，好比IPCConnectHandler()<IPCPreconnectorDelegate>,這個規則適用全部書寫協議的地方，包括函數聲明、類聲明、實例變量等等：

@interface MyProtocoledClass : NSObject<NSWindowDelegate> { @private id<MyFancyDelegate> _delegate; } - (void)setDelegate:(id<MyFancyDelegate>)aDelegate; @end

閉包（Blocks）

根據block的長度，有不一樣的書寫規則：

• 較短的block能夠寫在一行內。
• 若是分行顯示的話，block的右括號}應該和調用block那行代碼的第一個非空字符對齊。
• block內的代碼採用4個空格的縮進。
• 若是block過於龐大，應該單獨聲明成一個變量來使用。
• ^和(之間，^和{之間都沒有空格，參數列表的右括號)和{之間有一個空格。

//較短的block寫在一行內
[operation setCompletionBlock:^{ [self onOperationDone]; }]; //分行書寫的block，內部使用4空格縮進 [operation setCompletionBlock:^{ [self.delegate newDataAvailable]; }]; //使用C語言API調用的block遵循一樣的書寫規則 dispatch_async(_fileIOQueue, ^{ NSString* path = [self sessionFilePath]; if (path) { // ... } }); //較長的block關鍵字能夠縮進後在新行書寫，注意block的右括號'}'和調用block那行代碼的第一個非空字符對齊 [[SessionService sharedService] loadWindowWithCompletionBlock:^(SessionWindow *window) { if (window) { [self windowDidLoad:window]; } else { [self errorLoadingWindow]; } }]; //較長的block參數列表一樣能夠縮進後在新行書寫 [[SessionService sharedService] loadWindowWithCompletionBlock: ^(SessionWindow *window) { if (window) { [self windowDidLoad:window]; } else { [self errorLoadingWindow]; } }]; //龐大的block應該單獨定義成變量使用 void (^largeBlock)(void) = ^{ // ... }; [_operationQueue addOperationWithBlock:largeBlock]; //在一個調用中使用多個block，注意到他們不是像函數那樣經過':'對齊的，而是同時進行了4個空格的縮進 [myObject doSomethingWith:arg1 firstBlock:^(Foo *a) { // ... } secondBlock:^(Bar *b) { // ... }];

數據結構的語法糖

應該使用可讀性更好的語法糖來構造NSArray，NSDictionary等數據結構，避免使用冗長的alloc,init方法。

若是構造代碼寫在一行，須要在括號兩端留有一個空格，使得被構造的元素於與構造語法區分開來：

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

若是構造代碼不寫在一行內，構造元素須要使用兩個空格來進行縮進，右括號]或者}寫在新的一行，而且與調用語法糖那行代碼的第一個非空字符對齊：

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

構造字典時，字典的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", }; //錯誤，每個元素要麼單獨成爲一行，要麼所有寫在一行內 NSDictionary *alsoWrong= @{ AKey : @"a", BLongerKey : @"b" }; //錯誤，在冒號前只能有一個空格，冒號後才能夠考慮按照Value對齊 NSDictionary *stillWrong = @{ AKey : @"b", BLongerKey : @"c", };

命名規範

基本原則

清晰

命名應該儘量的清晰和簡潔，但在Objective-C中，清晰比簡潔更重要。因爲Xcode強大的自動補全功能，咱們沒必要擔憂名稱過長的問題。

//清晰
insertObject:atIndex:

//不清晰，insert的對象類型和at的位置屬性沒有說明 insert:at: //清晰 removeObjectAtIndex: //不清晰，remove的對象類型沒有說明，參數的做用沒有說明 remove:

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

//清晰
destinationSelection
setBackgroundColor:

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

然而，有部分單詞簡寫在Objective-C編碼過程當中是很是經常使用的，以致於成爲了一種規範，這些簡寫能夠在代碼中直接使用，下面列舉了部分：

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

命名方法或者函數時要避免歧義

//有歧義，是返回sendPort仍是send一個Port？
sendPort

//有歧義，是返回一個名字屬性的值仍是display一個name的動做？ displayName

一致性

整個工程的命名風格要保持一致性，最好和蘋果SDK的代碼保持統一。不一樣類中完成類似功能的方法應該叫同樣的名字，好比咱們老是用count來返回集合的個數，不能在A類中使用count而在B類中使用getNumber。

使用前綴

若是代碼須要打包成Framework給別的工程使用，或者工程項目很是龐大，須要拆分紅不一樣的模塊，使用命名前綴是很是有用的。

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

• 能夠在爲類、協議、函數、常量以及typedef宏命名的時候使用前綴，但注意不要爲成員變量或者方法使用前綴，由於他們自己就包含在類的命名空間內。

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

命名類和協議（Class&Protocol）

類名以大寫字母開頭，應該包含一個名詞來表示它表明的對象類型，同時能夠加上必要的前綴，好比NSString, NSDate,NSScanner, NSApplication等等。

而協議名稱應該清晰地表示它所執行的行爲，並且要和類名區別開來，因此一般使用ing詞尾來命名一個協議，好比NSCopying,NSLocking。

有些協議自己包含了不少不相關的功能，主要用來爲某一特定類服務，這時候能夠直接用類名來命名這個協議，好比NSObject協議，它包含了id對象在生存週期內的一系列方法。

命名頭文件（Headers）

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

• 若是頭文件內只定義了單個類或者協議，直接用類名或者協議名來命名頭文件，好比NSLocale.h定義了NSLocale類。

• 若是頭文件內定義了一系列的類、協議、類別，使用其中最主要的類名來命名頭文件，好比NSString.h定義了NSString和NSMutableString。

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

• Framework中有時候會實如今別的框架中類的類別擴展，這樣的文件一般使用被擴展的框架名+Additions的方式來命名，好比NSBundleAdditions.h。

命名方法（Methods）

Objective-C的方法名一般都比較長，這是爲了讓程序有更好地可讀性，按蘋果的說法「好的方法名應當能夠以一個句子的形式朗讀出來」。

方法通常以小寫字母打頭，每個後續的單詞首字母大寫，方法名中不該該有標點符號（包括下劃線），有兩個例外：

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

若是方法表示讓對象執行一個動做，使用動詞打頭來命名，注意不要使用do，does這種多餘的關鍵字，動詞自己的暗示就足夠了：

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

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

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

對於有多個參數的方法，務必在每個參數前都添加關鍵詞，關鍵詞應當清晰說明參數的做用：

//正確，保證每一個參數都有關鍵詞修飾
- (void)sendAction:(SEL)aSelector toObject:(id)anObject forAllCells:(BOOL)flag; //錯誤，遺漏關鍵詞 - (void)sendAction:(SEL)aSelector :(id)anObject :(BOOL)flag; //正確 - (id)viewWithTag:(NSInteger)aTag; //錯誤，關鍵詞的做用不清晰 - (id)taggedView:(int)aTag;

不要用and來鏈接兩個參數，一般and用來表示方法執行了兩個相對獨立的操做（從設計上來講，這時候應該拆分紅兩個獨立的方法）：

//錯誤，不要使用"and"來鏈接參數
- (int)runModalForDirectory:(NSString *)path andFile:(NSString *)name andTypes:(NSArray *)fileTypes; //正確，使用"and"來表示兩個相對獨立的操做 - (BOOL)openFile:(NSString *)fullPath withApplication:(NSString *)appName andDeactivate:(BOOL)flag;

方法的參數命名也有一些須要注意的地方:

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

下面列舉了一些經常使用參數名：

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

存取方法是指用來獲取和設置類屬性值的方法，屬性的不一樣類型，對應着不一樣的存取方法規範：

//屬性是一個名詞時的存取方法範式
- (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;

命名存取方法時不要將動詞轉化爲被動形式來使用：

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

可使用can,should,will等詞來協助表達存取方法的意思，但不要使用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中一般只用來表示從函數指針返回值的函數：

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

命名委託（Delegate）

當特定的事件發生時，對象會觸發它註冊的委託方法。委託是Objective-C中經常使用的傳遞消息的方式。委託有它固定的命名範式。

一個委託方法的第一個參數是觸發它的對象，第一個關鍵詞是觸發對象的類名，除非委託方法只有一個名爲sender的參數：

//第一個關鍵詞爲觸發委託的類名
- (BOOL)tableView:(NSTableView *)tableView shouldSelectRow:(int)row; - (BOOL)application:(NSApplication *)sender openFile:(NSString *)filename; //當只有一個"sender"參數時能夠省略類名 - (BOOL)applicationOpenUntitledFile:(NSApplication *)sender;

根據委託方法觸發的時機和目的，使用should,will,did等關鍵詞

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

若是管理的集合元素中有指向管理對象的指針，要設置成weak類型以防止引用循環。

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

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

命名函數（Functions）

在不少場合仍然須要用到函數，好比說若是一個對象是一個單例，那麼應該使用函數來代替類方法執行相關操做。

函數的命名和方法有一些不一樣，主要是：

• 函數名稱通常帶有縮寫前綴，表示方法所在的框架。
• 前綴後的單詞以「駝峯」表示法顯示，第一個單詞首字母大寫。

函數名的第一個單詞一般是一個動詞，表示方法執行的操做：

NSHighlightRect
NSDeallocateObject

若是函數返回其參數的某個屬性，省略動詞：

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

若是函數經過指針參數來返回值，須要在函數名中使用Get：

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

函數的返回類型是BOOL時的命名：

BOOL NSDecimalIsNotANumber(const NSDecimal *decimal)

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

屬性和對象的存取方法相關聯，屬性的第一個字母小寫，後續單詞首字母大寫，沒必要添加前綴。屬性按功能命名成名詞或者動詞：

//名詞屬性
@property (strong) NSString *title; //動詞屬性 @property (assign) BOOL showsAlpha;

屬性也能夠命名成形容詞，這時候一般會指定一個帶有is前綴的get方法來提升可讀性：

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

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

@implementation MyClass { BOOL _showsTitle; }

通常來講，類須要對使用者隱藏數據存儲的細節，因此不要將實例方法定義成公共可訪問的接口，可使用@private，@protected前綴。

按蘋果的說法，不建議在除了init和dealloc方法之外的地方直接訪問實例變量，但不少人認爲直接訪問會讓代碼更加清晰可讀，只在須要計算或者執行操做的時候才使用存取方法訪問，我就是這種習慣，因此這裏不做要求。

命名常量（Constants）

若是要定義一組相關的常量，儘可能使用枚舉類型（enumerations），枚舉類型的命名規則和函數的命名規則相同。 建議使用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定義浮點型或者單個的整數型常量，若是要定義一組相關的整數常量，應該優先使用枚舉。常量的命名規範和函數相同：

const float NSLightGray;

不要使用#define宏來定義常量，若是是整型常量，儘可能使用枚舉，浮點型常量，使用const定義。#define一般用來給編譯器決定是否編譯某塊代碼，好比經常使用的：

#ifdef DEBUG

注意到通常由編譯器定義的宏會在先後都有一個__，好比__MACH__。

命名通知（Notifications）

通知經常使用於在模塊間傳遞消息，因此通知要儘量地表示出發生的事件，通知的命名範式是：

[觸發通知的類名] + [Did | Will] + [動做] + Notification

栗子：

NSApplicationDidBecomeActiveNotification
NSWindowDidMiniaturizeNotification NSTextViewDidChangeSelectionNotification NSColorPanelColorDidChangeNotification

註釋

讀沒有註釋代碼的痛苦你我都體會過，好的註釋不只能讓人輕鬆讀懂你的程序，還能提高代碼的逼格。注意註釋是爲了讓別人看懂，而不是僅僅你本身。

文件註釋

每個文件都必須寫文件註釋，文件註釋一般包含

• 文件所在模塊
• 做者信息
• 歷史版本信息
• 版權信息
• 文件包含的內容，做用

一段良好文件註釋的栗子：

/*******************************************************************************
 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.  ********************************************************************************/

文件註釋的格式一般不做要求，能清晰易讀就能夠了，但在整個工程中風格要統一。

代碼註釋

好的代碼應該是「自解釋」（self-documenting）的，但仍然須要詳細的註釋來講明參數的意義、返回值、功能以及可能的反作用。

方法、函數、類、協議、類別的定義都須要註釋，推薦採用Apple的標準註釋風格，好處是能夠在引用的地方alt+點擊自動彈出註釋，很是方便。

有不少能夠自動生成註釋格式的插件，推薦使用VVDocumenter：

一些良好的註釋：

/**
 * 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

協議、委託的註釋要明確說明其被觸發的條件：

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

若是在註釋中要引用參數名或者方法函數名，使用||將參數或者方法括起來以免歧義：

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

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

定義在頭文件裏的接口方法、屬性必需要有註釋！

編碼風格

每一個人都有本身的編碼風格，這裏總結了一些比較好的Cocoa編程風格和注意點。

不要使用new方法

儘管不少時候能用new代替alloc init方法，但這可能會致使調試內存時出現不可預料的問題。Cocoa的規範就是使用alloc init方法，使用new會讓一些讀者困惑。

Public API要儘可能簡潔

共有接口要設計的簡潔，知足核心的功能需求就能夠了。不要設計不多會被用到，可是參數極其複雜的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呢？主要是爲了保證代碼在不一樣平臺間共享時不出現問題。

引用框架的根頭文件

上面提到過，每個框架都會有一個和框架同名的頭文件，它包含了框架內接口的全部引用，在使用框架的時候，應該直接引用這個根頭文件，而不是其它子模塊的頭文件，即便是你只用到了其中的一小部分，編譯器會自動完成優化的。

//正確，引用根頭文件
#import <Foundation/Foundation.h> //錯誤，不要單獨引用框架內的其它頭文件 #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變量只會取值的最後一個字節來賦值，這樣極可能會取到0（NO）。可是，一些邏輯操做符好比&&,||,!的返回是能夠直接賦給BOOL的：

//錯誤，不要將其它類型轉化爲BOOL返回
- (BOOL)isBold { return [self fontTraits] & NSFontBoldTrait; } - (BOOL)isValid { return [self stringValue]; } //正確 - (BOOL)isBold { return ([self fontTraits] & NSFontBoldTrait) ? YES : NO; } //正確，邏輯操做符能夠直接轉化爲BOOL - (BOOL)isValid { return [self stringValue] != nil; } - (BOOL)isEnabled { return [self isValid] && [self isBold]; }

另外BOOL類型能夠和_Bool,bool相互轉化，可是不能和Boolean轉化。

使用ARC

除非想要兼容一些古董級的機器和操做系統，咱們沒有理由放棄使用ARC。在最新版的Xcode(6.2)中，ARC是自動打開的，因此直接使用就行了。

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

當initdealloc方法被執行時，類的運行時環境不是處於正常狀態的，使用存取方法訪問變量可能會致使不可預料的結果，所以應當在這兩個方法內直接訪問實例變量。

//正確，直接訪問實例變量
- (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的生命週期結束時，每每須要作一些掃尾工做，好比釋放資源，中止線程等，這些掃尾工做的釋放順序應當與它們的初始化或者定義的順序保持一致。這樣作是爲了方便調試時尋找錯誤，也能防止遺漏。

保證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對象發送命令是不會拋出異常或者致使崩潰的，只是徹底的「什麼都不幹」，因此，只在程序中使用nil來作邏輯上的檢查。

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

//正確，直接判斷
if (!objc) { ... } //錯誤，不要使用nil == Object的形式 if (nil == objc) { ... }

屬性的線程安全

定義一個屬性時，編譯器會自動生成線程安全的存取方法（Atomic），但這樣會大大下降性能，特別是對於那些須要頻繁存取的屬性來講，是極大的浪費。因此若是定義的屬性不須要線程保護，記得手動添加屬性關鍵字nonatomic來取消編譯器的優化。

點分語法的使用

不要用點分語法來調用方法，只用來訪問屬性。這樣是爲了防止代碼可讀性問題。

//正確，使用點分語法訪問屬性
NSString *oldName = myObject.name; myObject.name = @"Alice"; //錯誤，不要用點分語法調用方法 NSArray *array = [NSArray arrayWithObject:@"hello"]; NSUInteger numberOfItems = array.count; array.release;

Delegate要使用弱引用

一個類的Delegate對象一般還引用着類自己，這樣很容易形成引用循環的問題，因此類的Delegate屬性要設置爲弱引用。

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