ios编码规范

Object-C 开发代码规范
概要
Object-C是一门面向对象的动态编程语言，主要用于编写IOS和MAC应用程序。关于Object-C苹果已经有很好的总结：
https://developer.apple.com/library/content/documentation/Cocoa/Conceptual/CodingGuidelines/CodingGuidelines.html

本文主要是整合了上述文档的翻译、自己的编程经验和其它相关资料，为公司总结出一份通用的编码规范。

代码格式
每一行的最大长度
同样的，在Xcode > Preferences > Text Editing > Page guide at column中将最大行长设置为80，过长的一行代码将会导致可读性问题。
函数的书写
一个典型的Object-C函数应该是这样的：

• (void)createMethodParam:(NSString*)str type:(NSInteger)type{
  ……
  }

在-和(void)之间应该有一个空格，第一个大括号{的位置在函数所在行的末尾，同样应该有一个空格。

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

• (void)initWithModel:(Model *)model
  param1:(NSString *) param1
  param2:(NSString *) param2
  param3:(NSString *) param3
  param4:(NSString *) param4;
  在分行时，如果第一段名称过短，后续名称可以以Tab的长度为单位进行缩进：
• (void)initWithModel:(Model *)model
  param1:(NSString *) param1
  paramString2:(NSString *) param2
  param4:(NSString *) param4;
  函数发送
  函数发送的格式和书写格式差不多，可以按照函数的长短来选择写在一行或者是分成多行：
  //写在一行
  [myObject doFooWith:arg1 name:arg2 error:arg3];

//分行写，按照:对齐
[myObject doFooWith:arg1
name:arg2
error:arg3];

//第一段名称过短的话后续可以进行缩进
[myObj short:arg1
longKeyword:arg2
evenLongerKeyword:arg3
error:arg4];
@public和@private标记符
@public和@private标记符应该以一个空格来进行缩进：
@interface MyClass : NSObject {
@public
...
@private
...
}
@end

协议（Protocols）
在书写协议的时候注意用<>括起来的协议和类型名之间是没有空格的，比如DemoClass()<DemoClassDelegate>,这个规则适用所有书写协议的地方，包括函数声明、类生命、实例变量等等：
@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], [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
};

命名规范
基本原则
清晰
命名应该尽可能的清晰和简洁，但在Object-C中，清晰比简洁更重要。由于Xcode强大的自动补全功能，我们不必担心名称过长的问题。

//清晰
insertObject:atIndex:

//不清晰，insert的对象类型和at的位置属性没有说明
insert:at:

//清晰
removeObjectAtIndex:

//不清晰，remove的对象类型没有说明，参数的作用没有说明
remove:

不要使用单词的简写，拼写出完整的单词：
//清晰
destinationSelection
setBackgroundColor:

//不清晰，不要使用简写
destSel
setBkgdColor:

然而，有部分单词简写在Object-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;

命名委托（Delegate）

当特定的事件发生时，对象会触发它注册的委托方法。委托是Objective-C中常用的传递消息的方式。委托有它固定的命名范式。

一个委托方法的第一个参数是触发它的对象，第一个关键词是触发对象的类名，除非委托方法只有一个名为sender的参数：

//第一个关键词为触发委托的类名

• (BOOL)tableView:(NSTableView *)tableView shouldSelectRow:(int)row;
• (BOOL)application:(NSApplication *)sender openFile:(NSString *)filename;

//当只有一个参数时可以省略类名

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

命名属性和实例变量（Properties&Instance Variables）

属性和对象的存取方法相关联，属性的第一个字母小写，后续单词首字母大写，不必添加前缀。属性按功能命名成名词或者动词：
//名词属性
@property (strong) NSString *title;

//动词属性
@property (assign) BOOL showsAlpha;

属性也可以命名成形容词，这时候通常会指定一个带有is前缀的get方法来提高可读性：
@property (assign, getter=isEditable) BOOL editable;

命名常量（Constants）

如果要定义一组相关的常量，尽量使用枚举类型（enumerations），枚举类型的命名规则和函数的命名规则相同。 建议使用 NS_ENUM 和 NS_OPTIONS 宏来定义枚举类型，参见官方的 https://developer.apple.com/library/content/releasenotes/ObjectiveC/ModernizationObjC/AdoptingModernObjective-C/AdoptingModernObjective-C.html 一文：
//定义一个枚举
typedef NS_ENUM(NSInteger, NSMatrixMode) {
NSRadioModeMatrix,
NSHighlightModeMatrix,
NSListModeMatrix,
NSTrackModeMatrix
};
使用const定义浮点型或者单个的整数型常量，如果要定义一组相关的整数常量，应该优先使用枚举。常量的命名规范和函数相同：
const float NSLightGray;

不要使用#define宏来定义常量，如果是整型常量，尽量使用枚举，浮点型常量，使用const定义。#define通常用来给编译器决定是否编译某块代码，比如常用的： #ifdef DEBUG
注意到一般由编译器定义的宏会在前后都有一个__，比如MACH。
注释

读没有注释代码的痛苦你我都体会过，好的注释不仅能让人轻松读懂你的程序，还能提升代码的逼格。注意注释是为了让别人看懂，而不是仅仅你自己。

文件注释

每一个文件都必须写文件注释，文件注释通常包含

文件所在模块
作者信息
历史版本信息
版权信息
文件包含的内容，作用
一段良好文件注释的例子：
文件注释的格式通常不作要求，能清晰易读就可以了，但在整个工程中风格要统一。

代码注释

好的代码应该是“自解释”（self-documenting）的，但仍然需要详细的注释来说明参数的意义、返回值、功能以及可能的副作用。

方法、函数、类、协议、类别的定义都需要注释，推荐采用Apple的标准注释风格，好处是可以在引用的地方alt+点击自动弹出注释，非常方便。