代码格式

使用空格而不是制表符Tab

不要在工程里使用Tab键，使用空格来进行缩进。在Xcode > Preferences > Text Editing将Tab和自动缩进都设置为4个空格。（Google的标准是使用两个空格来缩进，但这里还是推荐使用Xcode默认的设置。）

每一行的最大长度

同样的，在Xcode > Preferences > Text Editing > Page guide at column:中将最大行长设置为80，过长的一行代码将会导致可读性问题。

函数的书写

一个典型的Objective-C函数应该是这样的：

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

在-和(void)之间应该有一个空格，第一个大括号{的位置在函数所在行的末尾，同样应该有一个空格。（我司的C语言规范要求是第一个大括号单独占一行，但考虑到OC较长的函数名和苹果SDK代码的风格，还是将大括号放在行末。）

如果一个函数有特别多的参数或者名称很长，应该将其按照:来对齐分行显示：

  1. -(id)initWithModel:(IPCModle)model
  2.        ConnectType:(IPCConnectType)connectType
  3.         Resolution:(IPCResolution)resolution
  4.           AuthName:(NSString *)authName
  5.           Password:(NSString *)password
  6.                MAC:(NSString *)mac
  7.               AzIp:(NSString *)az_ip
  8.              AzDns:(NSString *)az_dns
  9.              Token:(NSString *)token
  10.              Email:(NSString *)email
  11.           Delegate:(id<IPCConnectHandlerDelegate>)delegate;

在分行时，如果第一段名称过短，后续名称可以以Tab的长度（4个空格）为单位进行缩进：

  1. - (void)short:(GTMFoo *)theFoo
  2.         longKeyword:(NSRect)theRect
  3.   evenLongerKeyword:(float)theInterval
  4.               error:(NSError **)theError {
  5.     ...
  6. }

函数调用

函数调用的格式和书写差不多，可以按照函数的长短来选择写在一行或者分成多行：

  1. //写在一行
  2. [myObject doFooWith:arg1 name:arg2 error:arg3];
  4. //分行写，按照':'对齐
  5. [myObject doFooWith:arg1
  6.                name:arg2
  7.               error:arg3];
  9. //第一段名称过短的话后续可以进行缩进
  10. [myObj short:arg1
  11.           longKeyword:arg2
  12.     evenLongerKeyword:arg3
  13.                 error:arg4];

以下写法是错误的：

  1. //错误，要么写在一行，要么全部分行
  2. [myObject doFooWith:arg1 name:arg2
  3.               error:arg3];
  4. [myObject doFooWith:arg1
  5.                name:arg2 error:arg3];
  7. //错误，按照':'来对齐，而不是关键字
  8. [myObject doFooWith:arg1
  9.           name:arg2
  10.           error:arg3];

@public和@private标记符

@public和@private标记符应该以一个空格来进行缩进：

  1. @interface MyClass : NSObject {
  2.  @public
  3.   ...
  4.  @private
  5.   ...
  6. }
  7. @end

协议（Protocols）

在书写协议的时候注意用<>括起来的协议和类型名之间是没有空格的，比如IPCConnectHandler()<IPCPreconnectorDelegate>,这个规则适用所有书写协议的地方，包括函数声明、类声明、实例变量等等：

  1. @interface MyProtocoledClass : NSObject<NSWindowDelegate> {
  2.  @private
  3.     id<MyFancyDelegate> _delegate;
  4. }
  6. - (void)setDelegate:(id<MyFancyDelegate>)aDelegate;
  7. @end

闭包（Blocks）

根据block的长度，有不同的书写规则：

  • 较短的block可以写在一行内。
  • 如果分行显示的话，block的右括号}应该和调用block那行代码的第一个非空字符对齐。
  • block内的代码采用4个空格的缩进。
  • 如果block过于庞大，应该单独声明成一个变量来使用。
  • ^和(之间，^和{之间都没有空格，参数列表的右括号)和{之间有一个空格。
  1. //较短的block写在一行内
  2. [operation setCompletionBlock:^{ [self onOperationDone]; }];
  4. //分行书写的block，内部使用4空格缩进
  5. [operation setCompletionBlock:^{
  6.     [self.delegate newDataAvailable];
  7. }];
  9. //使用C语言API调用的block遵循同样的书写规则
  10. dispatch_async(_fileIOQueue, ^{
  11.     NSString* path = [self sessionFilePath];
  12.     if (path) {
  13.       // ...
  14.     }
  15. });
  17. //较长的block关键字可以缩进后在新行书写，注意block的右括号'}'和调用block那行代码的第一个非空字符对齐
  18. [[SessionService sharedService]
  19.     loadWindowWithCompletionBlock:^(SessionWindow *window) {
  20.         if (window) {
  21.           [self windowDidLoad:window];
  22.         } else {
  23.           [self errorLoadingWindow];
  24.         }
  25.     }];
  27. //较长的block参数列表同样可以缩进后在新行书写
  28. [[SessionService sharedService]
  29.     loadWindowWithCompletionBlock:
  30.         ^(SessionWindow *window) {
  31.             if (window) {
  32.               [self windowDidLoad:window];
  33.             } else {
  34.               [self errorLoadingWindow];
  35.             }
  36.         }];
  38. //庞大的block应该单独定义成变量使用
  39. void (^largeBlock)(void) = ^{
  40.     // ...
  41. };
  42. [_operationQueue addOperationWithBlock:largeBlock];
  44. //在一个调用中使用多个block，注意到他们不是像函数那样通过':'对齐的，而是同时进行了4个空格的缩进
  45. [myObject doSomethingWith:arg1
  46.     firstBlock:^(Foo *a) {
  47.         // ...
  48.     }
  49.     secondBlock:^(Bar *b) {
  50.         // ...
  51.     }];

数据结构的语法糖

应该使用可读性更好的语法糖来构造NSArray，NSDictionary等数据结构，避免使用冗长的alloc,init方法。

如果构造代码写在一行，需要在括号两端留有一个空格，使得被构造的元素于与构造语法区分开来：

  1. //正确，在语法糖的"[]"或者"{}"两端留有空格
  2. NSArray *array = @[ [foo description], @"Another String", [bar description] ];
  3. NSDictionary *dict = @{ NSForegroundColorAttributeName : [NSColor redColor] };
  5. //不正确，不留有空格降低了可读性
  6. NSArray* array = @[[foo description], [bar description]];
  7. NSDictionary* dict = @{NSForegroundColorAttributeName: [NSColor redColor]};

如果构造代码不写在一行内，构造元素需要使用两个空格来进行缩进，右括号]或者}写在新的一行，并且与调用语法糖那行代码的第一个非空字符对齐：

  1. NSArray *array = @[
  2.   @"This",
  3.   @"is",
  4.   @"an",
  5.   @"array"
  6. ];
  8. NSDictionary *dictionary = @{
  9.   NSFontAttributeName : [NSFont fontWithName:@"Helvetica-Bold" size:12],
  10.   NSForegroundColorAttributeName : fontColor
  11. };

构造字典时，字典的Key和Value与中间的冒号:都要留有一个空格，多行书写时，也可以将Value对齐：

  1. //正确，冒号':'前后留有一个空格
  2. NSDictionary *option1 = @{
  3.   NSFontAttributeName : [NSFont fontWithName:@"Helvetica-Bold" size:12],
  4.   NSForegroundColorAttributeName : fontColor
  5. };
  7. //正确，按照Value来对齐
  8. NSDictionary *option2 = @{
  9.   NSFontAttributeName :            [NSFont fontWithName:@"Arial" size:12],
  10.   NSForegroundColorAttributeName : fontColor
  11. };
  13. //错误，冒号前应该有一个空格
  14. NSDictionary *wrong = @{
  15.   AKey:       @"b",
  16.   BLongerKey: @"c",
  17. };
  19. //错误，每一个元素要么单独成为一行，要么全部写在一行内
  20. NSDictionary *alsoWrong= @{ AKey : @"a",
  21.                             BLongerKey : @"b" };
  23. //错误，在冒号前只能有一个空格，冒号后才可以考虑按照Value对齐
  24. NSDictionary *stillWrong = @{
  25.   AKey       : @"b",
  26.   BLongerKey : @"c",
  27. };