代碼格式

使用空格而不是制表符Tab

不要在工程里使用Tab鍵茄蚯，使用空格來進(jìn)行縮進(jìn)付秕。在Xcode > Preferences > Text Editing將Tab和自動縮進(jìn)都設(shè)置為4個空格。（Google的標(biāo)準(zhǔn)是使用兩個空格來縮進(jìn)，但這里還是推薦使用Xcode默認(rèn)的設(shè)置。）

每一行的最大長度

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

函數(shù)的書寫

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

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

在-和(void)之間應(yīng)該有一個空格革娄，第一個大括號{的位置在函數(shù)所在行的末尾，同樣應(yīng)該有一個空格匆浙。（我司的C語言規(guī)范要求是第一個大括號單獨(dú)占一行首尼，但考慮到OC較長的函數(shù)名和蘋果SDK代碼的風(fē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<IPCConnectHandlerDelegate>)delegate;

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

- (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ù)可以進(jìn)行縮進(jìn)
[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標(biāo)記符

@public和@private標(biāo)記符應(yīng)該以一個空格來進(jìn)行縮進(jìn)：

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

協(xié)議（Protocols）

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

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

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

閉包（Blocks）

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

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

//較短的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) {
      // ...
    }
});

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

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

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

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

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

應(yīng)該使用可讀性更好的語法糖來構(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)造元素需要使用兩個空格來進(jìn)行縮進(jìn)，右括號]或者}寫在新的一行妒牙，并且與調(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
};

//錯誤蚪拦，冒號前應(yīng)該有一個空格
NSDictionary *wrong = @{
  AKey:       @"b",
  BLongerKey: @"c",
};

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

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

基本原則

清晰

命名應(yīng)該盡可能的清晰和簡潔漓库，但在Objective-C中，清晰比簡潔更重要痢士。由于Xcode強(qiáng)大的自動補(bǔ)全功能茂装，我們不必?fù)?dān)心名稱過長的問題。

//清晰
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

一致性

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

使用前綴

如果代碼需要打包成Framework給別的工程使用，或者工程項(xiàng)目非常龐大已卸，需要拆分成不同的模塊，使用命名前綴是非常有用的累澡。

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

• 可以在為類、協(xié)議腮介、函數(shù)、常量以及typedef宏命名的時候使用前綴叠洗，但注意不要為成員變量或者方法使用前綴旅东，因?yàn)樗麄儽旧砭桶陬惖拿臻g內(nèi)十艾。
  （讀者疑問：好多三方庫的方法不都有前綴嗎？例如mj_忘嫉、sd_）

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

命名類和協(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)的一系列方法剖笙。

命名頭文件（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中有時候會實(shí)現(xiàn)在別的框架中類的類別擴(kuò)展抽活，這樣的文件通常使用被擴(kuò)展的框架名+Additions的方式來命名锰什，比如NSBundleAdditions.h汁胆。

命名方法（Methods）

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

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

• 可以用一些通用的大寫字母縮寫打頭方法，比如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)當(dāng)清晰說明參數(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í)行了兩個相對獨(dú)立的操作（從設(shè)計上來說，這時候應(yīng)該拆分成兩個獨(dú)立的方法）：

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

//正確，使用"and"來表示兩個相對獨(dú)立的操作
- (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