iOS编码规范

2018-11-11 本文已影响38人 Oneruofeng

概览

为了减少团队的大家代码风格的不一致，降低出错率，提供代码的可维护性，针对App自身特点制定以下规范。

规范按照执行力度分为

强制遵守【must】
建议遵守【suggest】
最佳实践【best practice】

强制遵守：为一些非常重要的原则和既定的约定，下面简称【M】
建议遵守：为一些建议遵守的原则和代码风格，下面简称【S】
最佳实践：为一些经过实践验证比较优的写法，下面简称【BP】

这篇文章内容主要包含以下三个部分

核心原则:介绍了这篇代码规范所遵循的核心原则
通用规范:不局限于iOS的通用性的代码规范（使用C语言和Swift语言）
iOS规范:仅适用于iOS的代码规范（使用Objective-C语言）

每条原则有一个默认执行力度，最终执行力度将由大家团队讨论，半数以上的得票为最终方案，在执行过程中更加反馈，后续可能会有所调整，直到最佳。

一. 核心原则【M】

原则一：简洁性原则--代码应该简洁易懂，逻辑清晰

因为软件是需要人来维护的。这个人在未来很可能是你也可算是你的同事，简洁的代码易于维护。

不要过分追求技巧，降低程序的可读性。
简洁的代码可以让bug无处藏身。要写出明显没有bug的代码，而不是没有明显bug的代码。

原则二：可拓展性--面向变化编程，而不是面向需求编程。

需求是暂时的，只有变化才是永恒的。
本次迭代不能仅仅为了当前的需求，写出扩展性强，易修改的程序才是负责任的做法，对自己负责，对公司负责。

原则三：效率优先--先保证程序的正确性，防止过度工程

过度工程（over-engineering）：在正确可用的代码写出之前就过度地考虑扩展，重用的问题，使得工程过度复杂。
引用《王垠：编程的智慧》里的话：

先把眼前的问题解决掉，解决好，再考虑将来的扩展问题。

先写出可用的代码，反复推敲，再考虑是否需要重用的问题。

先写出可用，简单，明显没有bug的代码，再考虑测试的问题。

二. 通用规范

格式【M】

使用4个空格(tab)来缩进
方法- 和 + 和返回值之前为1个空格
方法参数之间有一个空格，其他地方不出现多余的空格
方法长度不超过80行，建议不超过50行。

大括号【S】

控制语句(if,for,while,switch)中，大括号开始与行尾
函数中，大括号要开始于行首

推荐这样写：

//控制语句
while(someCondition) {

}

if (someCondition) {

} else {

}

for (NSInteger i = 0; i < 5; i++) {

}

//函数
void function(param1,param2)
{

}

运算符

1. 运算符与变量之间的间隔

1.1 一元运算符与变量之间没有空格【M】：

!bValue
~iValue
++iCount
*strSource
&fSum

1.2 二元运算符与变量之间必须有空格【M】

fWidth = 5 + 5;
fLength = fWidth * 2;
fHeight = fWidth + fLength;
for (int i = 0; i < 10; i++)

2. 多个不同的运算符同时存在时应该使用括号来明确优先级【M】

在多个不同的运算符同时存在的时候应该合理使用括号，不要盲目依赖操作符优先级。
因为有的时候不能保证阅读你代码的人就一定能了解你写的算式里面所有操作符的优先级。

来看一下这个算式：2 << 2 + 1 * 3 - 4

这里的<<是移位操作直观上却很容易认为它的优先级很高，所以就把这个算式误认为：(2 << 2) + 1 *3 - 4
但事实上，它的优先级是比加减法还要低的，所以该算式应该等同于：2 << (2 + 1 *3 - 4)。
所以在以后写这种复杂一点的算式的时候，尽量多加一点括号，避免让其他人误解（甚至是自己）。

变量

1. 一个变量有且只有一个功能，尽量不要把一个变量用作多种用途【M】

2. 变量在使用前应初始化，防止未初始化的变量被引用【M】

3. 局部变量应该尽量接近使用它的地方【S】

推荐这样写：

func someFunction() {

 let index = ...;
 //Do something With index

 ...
 ...

 let count = ...;
 //Do something With count

}

不推荐这样写：

func someFunction() {

 let index = ...;
 let count = ...;
 //Do something With index

 ...
 ...

 //Do something With count
}

if语句

1. 必须列出所有分支（穷举所有的情况），而且每个分支都必须给出明确的结果。【S】

推荐这样写：

var hintStr;
if (count < 3) {
    hintStr = "Good";
} else {
    hintStr = "";
}

不推荐这样写：

var hintStr;
if (count < 3) {
    hintStr = "Good";
}

2. 不要使用过多的分支，要善于使用return来提前返回错误的情况【M】

推荐这样写：

- (void)someMethod {
    if (!goodCondition) {
        return;
    }
    //Do something
}

不推荐这样写：

- (instancetype)initWithDictionary:(NSDictionary *)dict error:(NSError)err
{
 //方法1\. 参数为nil
 if (!dict) {
 if (err) *err = [JSONModelError errorInputIsNil];
 return nil;
    }

    //方法2\. 参数不是nil，但也不是字典
    if (![dict isKindOfClass:[NSDictionary class]]) {
        if (err) *err = [JSONModelError errorInvalidDataWithMessage:@"Attempt to initialize JSONModel object using initWithDictionary:error: but the dictionary parameter was not an 'NSDictionary'."];
        return nil;
    }

    //方法3\. 初始化
    self = [self init];
    if (!self) {
        //初始化失败
        if (err) *err = [JSONModelError errorModelIsInvalid];
        return nil;
    }

    //方法4\. 检查用户定义的模型里的属性集合是否大于传入的字典里的key集合（如果大于，则返回NO）
    if (![self __doesDictionary:dict matchModelWithKeyMapper:self.__keyMapper error:err]) {
        return nil;
    }

    //方法5\. 核心方法：字典的key与模型的属性的映射
    if (![self __importDictionary:dict withKeyMapper:self.__keyMapper validation:YES error:err]) {
        return nil;
    }

    //方法6\. 可以重写[self validate:err]方法并返回NO，让用户自定义错误并阻拦model的返回
    if (![self validate:err]) {
        return nil;
    }

    //方法7\. 终于通过了！成功返回model
    return self;
}

可以看到，在这里，首先判断出各种错误的情况然后提前返回，把最正确的情况放到最后返回。

3. 条件表达式如果很长，则需要将他们提取出来赋给一个BOOL值【M】

推荐这样写：

let nameContainsSwift = sessionName.hasPrefix("Swift")
let isCurrentYear = sessionDateCompontents.year == 2014
let isSwiftSession = nameContainsSwift && isCurrentYear
if (isSwiftSession) { 
 // Do something
}

不推荐这样写：

if ( sessionName.hasPrefix("Swift") && (sessionDateCompontents.year == 2014) ) { 
 // Do something
}

4. 条件语句的判断应该是变量在左，常量在右【S】

推荐这样写：

if ( count == 6) {
}

或者

if ( object == nil) {
}

或者

if ( !object ) {
}

不推荐这样写：

if ( 6 == count) {
}

或者

if ( nil == object ) {
}

5. 每个分支的实现代码都必须被大括号包围【S】

推荐这样写：

if (!error) {
 return success;
}

不推荐这样写：

if (!error)
 return success;

或者

if (!error) return success;

6. 条件过多，过长的时候应该换行【S】

推荐这样写：

if (condition1() && 
    condition2() && 
    condition3() && 
    condition4()) {
  // Do something
}

不推荐这样写：

if (condition1() && condition2() && condition3() && condition4()) {
  // Do something
}

for语句

1. 不可在for循环内修改循环变量，防止for循环失去控制。【M】

for (int index = 0; index < 10; index++){
    ...
    logicToChange(index)
}

2. 避免使用continue和break。【S】

continue和break所描述的是“什么时候不做什么”，所以为了读懂二者所在的代码，我们需要在头脑里将他们取反。

其实最好不要让这两个东西出现，因为我们的代码只要体现出“什么时候做什么”就好了，而且通过适当的方法，是可以将这两个东西消灭掉的：

2.1 如果出现了continue，只需要把continue的条件取反即可

var filteredProducts = Array<String>()
for level in products {
    if level.hasPrefix("bad") {
        continue
    }
    filteredProducts.append(level)
}

我们可以看到，通过判断字符串里是否含有“bad”这个prefix来过滤掉一些值。其实我们是可以通过取反，来避免使用continue的：

for level in products {
    if !level.hasPrefix("bad") {
        filteredProducts.append(level)
    }
}

2.2 消除while里的break：将break的条件取反，并合并到主循环里

在while里的block其实就相当于“不存在”，既然是不存在的东西就完全可以在最开始的条件语句中将其排除。

while里的break：

while (condition1) {
    ... 
    if (condition2) {
        break;
    }
}

取反并合并到主条件：

while (condition1 && !condition2) {
  ...
}

2.3 在有返回值的方法里消除break：将break转换为return立即返回

有些朋友喜欢这样做：在有返回值的方法里break之后，再返回某个值。其实完全可以在break的那一行直接返回。

func hasBadProductIn(products : Array<String>) -> Bool {

    var result = false
    for level in products {
        if level.hasPrefix("bad") {
            result = true
        }
    }
    return result
}

遇到错误条件直接返回：

func hasBadProductIn(products: Array<String>) -> Bool {
 for level in products {
 if level.hasPrefix("bad") {
 return true
 }
 }
 return false
}

这样写的话不用特意声明一个变量来特意保存需要返回的值，看起来非常简洁，可读性高。

Switch语句

1. 每个分支都必须用大括号括起来，每个case太长建议后面空一行再写下一个case【S】

推荐这样写：

switch (integer) {
    case 1:
        {
            // ...
        }
        break;
    case 2:
        {
            // ...
        }
        break;
    case 3:
        {
            // ...
        }
        break;
    default:
        {
            // ...
        }
        break;
}

或
switch (integer) {
    case 1:{
            // ...
        }
        break;
        
    case 2:{
            // ...
        }
        break;

    case 3:{
            // ...
        }
        break;
        
    default:{
            // ...
        }
        break;
}

2. 使用枚举类型时，不能有default分支，除了使用枚举类型以外，都必须有default分支【M】

RWTLeftMenuTopItemType menuType = RWTLeftMenuTopItemMain;
switch (menuType) {
    case RWTLeftMenuTopItemMain:
        {
            // ...
            break;
        }
    case RWTLeftMenuTopItemShows:
        {
            // ...
            break;
        }
    case RWTLeftMenuTopItemSchedule:
        {
            // ...
            break;
        }
}

在Switch语句使用枚举类型的时候，如果使用了default分支，在将来就无法通过编译器来检查新增的枚举类型了。

函数

1. 一个函数的长度必须限制在80行以内，建议50行以内【M】

通常来说，在阅读一个函数的时候，如果视需要跨过很长的垂直距离会非常影响代码的阅读体验。如果需要来回滚动眼球或代码才能看全一个方法，就会很影响思维的连贯性，对阅读代码的速度造成比较大的影响。最好的情况是在不滚动眼球或代码的情况下一眼就能将该方法的全部代码映入眼帘。

2. 一个函数只做一件事（单一原则）【M】

每个函数的职责都应该划分的很明确（就像类一样）。

推荐这样写：

dataConfiguration()
viewConfiguration()

不推荐这样写：

void dataConfiguration()
{ 
    ...
    viewConfiguration()
}

3. 对于有返回值的函数（方法），每一个分支都必须有返回值【S】

推荐这样写：

int function() {
    if (condition1) {
        return count1
    } else if (condition2) {
        return count2
    } else {
        return defaultCount
    }
}

不推荐这样写：

int function（） {
    if (condition1) {
        return count1
    } else if (condition2) {
        return count2
    }
}

4. 对输入参数的正确性和有效性进行检查，参数错误立即返回【S】

推荐这样写：

void function(param1, param2)
{
 if (param1 is unavailable){
    return;
 }

 if (param2 is unavailable){
    return;
 }

 //Do some right thing
}

5. 如果在不同的函数内部有相同的功能，应该把相同的功能抽取出来单独作为另一个函数【S】

原来的调用：

void logic() {
    a();
    b()； 
    if (logic1 condition) {
        c();
    } else {
        d();
    }
}

将a，b函数抽取出来作为单独的函数

void basicConfig() {
  a();
  b();
}

void logic1() {
  basicConfig();
  c();
}

void logic2() {
  basicConfig();
  d();
}

6. 将函数内部比较复杂的逻辑提取出来作为单独的函数【S】

一个函数内的不清晰（逻辑判断比较多，行数较多）的那片代码，往往可以被提取出去，构成一个新的函数，然后在原来的地方调用它这样你就可以使用有意义的函数名来代替注释，增加程序的可读性。

举一个发送邮件的例子：

openEmailSite();
login();

writeTitle(title);
writeContent(content);
writeReceiver(receiver);
addAttachment(attachment);

send();

中间的部分稍微长一些，我们可以将它们提取出来：

void writeEmail(title, content,receiver,attachment)
{
 writeTitle(title);
 writeContent(content);
 writeReceiver(receiver);
 addAttachment(attachment); 
}

然后再看一下原来的代码：

openEmailSite();
login();
writeEmail(title, content,receiver,attachment)
send();

8. 避免使用全局变量，类成员（class member）来传递信息，尽量使用局部变量和参数。【M】

在一个类里面，经常会有传递某些变量的情况。而如果需要传递的变量是某个全局变量或者属性的时候，有些朋友不喜欢将它们作为参数，而是在方法内部就直接访问了：

class A {
    var x;

    func updateX() {
        ...x = ...;
    }

    func printX() {
        updateX();
        print(x);
    }
}

我们可以看到，在printX方法里面，updateX和print方法之间并没有值的传递，乍一看我们可能不知道x从哪里来的，导致程序的可读性降低了。

而如果你使用局部变量而不是类成员来传递信息，那么这两个函数就不需要依赖于某一个类，而且更加容易理解，不易出错：

func updateX() - > String {
    x = ...;
    return x;
}

func printX() {
    String x = updateX();
    print(x);
}

注释规范

参考：Cocoa代码风格指南之注释规范（三）

优秀的代码大部分是可以自描述的，我们完全可以用程代码本身来表达它到底在干什么，而不需要注释的辅助。

但并不是说一定不能写注释，有以下几种情况比较适合写注释：

解释实现文件中复杂的逻辑
对代码进行标注
对接口进行说明
容易产生歧义的代码

除了上述这几种情况，如果别人只能依靠注释才能读懂你的代码的时候，就要反思代码出现了什么问题。

最后，对于注释的内容，相对于“做了什么”，更应该说明“为什么这么做”。

解释实现文件中复杂的逻辑

在实现文件中，有时候会有一些复杂的逻辑，这种情况通过看代码去理解代价往往很大。如果不写备注，可能以后连自己都很难维护。所以，就算现在你对这些代码的逻辑有很清晰的理解，也最好写上备注，因为以后你肯定会忘记。这种注释由于不需要文档化，也不需要联想，所以使用 C/C++ 的注释风格就可以。当然如果你有文档化的需求，那还是按照统一的注释风格。

// 这是注释
/* 这是也是注释 */

对代码进行标注

在程序中，我们见过最多的注释莫过于//TODO了。这种注释如果在后边加上“:”就能在方法列表中显示，效果类似于#pragma mark。Xcode支持类似功能的注释有如下几种。

//MARK:MARK
//TODO:TODO
//FIXME:FIXME
// !!!:!!!
//???:???

这样的注释能够起到对代码进行标记的作用。比如项目中如果存在还没有完成的功能就可以加上//TODO:Response button event。如果某块代码需要修改，可以加上//FIXME:There is a problem on iOS7。如果你需要警告他人// !!!:DO NOT TOUCH MY CODE!。或者你对哪里的代码有不解（不满）//???:What is this shit。如果你想在方法内部实现像#pragma mark一样的标注，就可以使用//MARK:Initialization，是的，就是这么简单。如果你很另类，你还可以这样来注释代码。

对接口进行说明

当我们封装库或在开发较复杂的项目时，因为接口需要供多人使用，所以对接口的注释说明就十分重要。

先说行尾注释。生成文档的话，只有Docxygen是支持行尾注释的。但是所幸 Xcode Quick Help 的支持让我们有了使用的理由。

行尾注释有以下几种

/**< 行尾注释1. AppleDoc 不支持会变为下一项的注释, Quick Help 支持，Doxygen 支持, 根据英文句号自动切分简要描述与详细描述. */
/*!< 行尾注释2. AppleDoc 不支持会变为下一项的注释, Quick Help 支持，Doxygen 支持, 会全部当作详细描述, 而缺少简要描述. */
///< 行尾注释3. AppleDoc 不支持会变为下一项的注释, Quick Help 不支持, Doxygen 支持。
//!< 行尾注释4. AppleDoc 不支持会会忽略, Quick Help 支持, Doxygen 支持。

通用二级标签

Xcode 基本支持所有的二级标签颜色加深的功能。二级标签可以在生成文档、联想和使用 Quick Help 时显示。不加任何标签的情况的下生成文档，单行注释默认为简要描述。多行注释默认为详细描述。在使用多行注释的时候也可以在不加标签的情况下同时生成简要描述和详细描述

/** 简要描述
 * 详细描述
 */
///简要描述.详细描述

多行注释中的简要描述也可以用@brief来代替。除此之外还有很多支持的二级标签。这里列举一些 AppleDoc 和 Doxygen 均支持的常用二级标签。

/**
 * @brief <title>: 简要注释. appledoc中仅对属性、方法有效，对类、协议 无效，会造成后续内容解析失败.
 * @param <name> <description>: 参数描述.
 * @return <description>: 返回值描述.
 * @exception <name> <description>: 异常描述.
 * @see <name>: 参见.
 * @sa <name>: 参见. 同@see.
 * @warning <text>: 警告.
 * @bug <text>: 警告.
 * @name <title>: 组名. 用于给成员们分组, 既文档中Tasks区的子类别.
 * 代码块 `int sum = 0;`
 * 多行代码块:
 *     int sum = 0;
 *     for(int i = 1; i <= 10; i++) {
 *         sum += i;
 *     }
 * 无序列表:
 * - first
 * - second
 * - third
 * 有序列表:
 * 1. first
 * 2. second
 * 3. third
 * 多级列表:
 * - abc
 *    - a
 *    - b
 *    - c
 * - rgb
 *    - red
 *        1. first.
 *            1. alpha.
 *            2. beta.
 *        2. second.
 *        3. third.
 *    - green
 *    - blue
 * 链接:
 * <http://www.xuyafei.cn>
 * [xuyafei](<http://www.xuyafei.cn>)
 */

下边是 Quick Help 支持的常用二级标签。

/**
 * @brief It converts temperature degrees from Celsius to Fahrenheit scale.
 * @param  fromCelcius The celsius degrees value.
 * @return float The degrees in the Fahrenheit scale.
 * @code
 *     float f = [self toCelsius:80];
 * @endcode
 * @remark This is a super-easy method.
 */

Code Review

换行、注释、方法长度、代码重复等这些是通过机器检查出来的问题，是无需通过人来做的。

而且除了审查需求的实现的程度，bug是否无处藏身以外，更应该关注代码的设计。比如类与类之间的耦合程度，设计的可扩展性，复用性，是否可以将某些方法抽出来作为接口等等。

三. iOS规范

变量

1. 变量名必须使用驼峰格式【M】

类，协议使用大驼峰：

HomePageViewController<HeaderViewDelegate>

对象等局部变量使用小驼峰：

NSString *personName = @"";
NSUInteger totalCount = 0;

2. 变量的名称必须同时包含功能与类型【S】

UIButton *addBtn //添加按钮
UILabel *nameLbl //名字标签
NSString *addressStr//地址字符串

3. 系统常用类作实例变量声明时加入后缀【S】

类型	后缀
UIViewController	VC
UIView	View
UILabel	Lbl
UIButton	Btn
UIImage	Img
UIImageView	ImagView
NSArray	Array
NSMutableArray	Marray
NSDictionary	Dict
NSMutableDictionary	Mdict
NSString	Str
NSMutableString	MStr
NSSet	Set
NSMutableSet	Mset

常量

1. 常量以相关类名作为前缀【S】

推荐这样写：

static const NSTimeInterval ZOCSignInViewControllerFadeOutAnimationDuration = 0.4;

不推荐这样写：

static const NSTimeInterval fadeOutTime = 0.4;

2. 建议使用类型常量，不建议使用#define预处理命令【S】

首先比较一下这两种声明常量的区别：

预处理命令：简单的文本替换，不包括类型信息，并且可被任意修改。
类型常量：包括类型信息，并且可以设置其使用范围，而且不可被修改。

使用预处理虽然能达到替换文本的目的，但是本身还是有局限性的：

不具备类型信息。
可以被任意修改。

3. 对外公开某个常量：【M】

如果我们需要发送通知，那么就需要在不同的地方拿到通知的“频道”字符串（通知的名称），那么显然这个字符串是不能被轻易更改，而且可以在不同的地方获取。这个时候就需要定义一个外界可见的字符串常量。

推荐这样写：

//头文件
extern NSString *const ZOCCacheControllerDidClearCacheNotification;

//实现文件
static NSString * const ZOCCacheControllerDidClearCacheNotification = @"ZOCCacheControllerDidClearCacheNotification";
static const CGFloat ZOCImageThumbnailHeight = 50.0f;

不推荐这样写：

#define CompanyName @"Apple Inc." 
#define magicNumber 42

宏

1. 宏、常量名都要使用大写字母，用下划线‘_’分割单词。【S】

// TODO

#define URL_GAIN_QUOTE_LIST @"/v1/quote/list"
#define URL_UPDATE_QUOTE_LIST @"/v1/quote/update"
#define URL_LOGIN  @"/v1/user/login”

2. 宏定义中如果包含表达式或变量，表达式和变量必须用小括号括起来。

#define MY_MIN(A, B)  ((A)>(B)?(B):(A))

CGRect函数

其实iOS内部已经提供了相应的获取CGRect各个部分的函数了，它们的可读性比较高，而且简短，推荐使用：

推荐这样写：

CGRect frame = self.view.frame; 
CGFloat x = CGRectGetMinX(frame); 
CGFloat y = CGRectGetMinY(frame); 
CGFloat width = CGRectGetWidth(frame); 
CGFloat height = CGRectGetHeight(frame); 
CGRect frame = CGRectMake(0.0, 0.0, width, height);

而不是

CGRect frame = self.view.frame;  
CGFloat x = frame.origin.x;  
CGFloat y = frame.origin.y;  
CGFloat width = frame.size.width;  
CGFloat height = frame.size.height;  
CGRect frame = (CGRect){ .origin = CGPointZero, .size = frame.size };

范型

建议在定义NSArray和NSDictionary时使用泛型，可以保证程序的安全性：

NSArray<NSString *> *testArr = [NSArray arrayWithObjects:@"Hello", @"world", nil];
NSDictionary<NSString *, NSNumber *> *dic = @{@"key":@(1), @"age":@(10)};

Block

为常用的Block类型创建typedef 【S】

如果我们需要重复创建某种block（相同参数，返回值）的变量，我们就可以通过typedef来给某一种块定义属于它自己的新类型

例如：

int (^variableName)(BOOL flag, int value) =^(BOOL flag, int value){
     // Implementation
     return someInt;
}

这个Block有一个bool参数和一个int参数，并返回int类型。我们可以给它定义类型：

int(^EOCSomeBlock)(BOOL flag, int value);

再次定义的时候，就可以通过简单的赋值来实现：

EOCSomeBlock block = ^(BOOL flag, int value){
// Implementation
};

定义作为参数的Block：

- (void)startWithCompletionHandler: (void(^)(NSData *data, NSError *error))completion;

这里的Block有一个NSData参数，一个NSError参数并没有返回值

typedef void(^EOCCompletionHandler)(NSData *data, NSError *error);

- (void)startWithCompletionHandler:(EOCCompletionHandler)

通过typedef定义Block签名的好处是:如果要某种块增加参数，那么只修改定义签名的那行代码

字面量

尽量使用字面量值来创建 NSString , NSDictionary , NSArray , NSNumber 这些不可变【S】

推荐这样写：

    NSArray *names = @[@"Brian", @"Matt", @"Chris", @"Alex", @"Steve", @"Paul"];
    NSDictionary *productManagers = @{@"iPhone" : @"Kate", @"iPad" : @"Kamal", @"Mobile Web" : @"Bill"}; 
    NSNumber *shouldUseLiterals = @YES;NSNumber *buildingZIPCode = @10018;

不推荐这样写：

NSArray *names = [NSArray arrayWithObjects:@"Brian", @"Matt", @"Chris", @"Alex", @"Steve", @"Paul", nil];
NSDictionary *productManagers = [NSDictionary dictionaryWithObjectsAndKeys: @"Kate", @"iPhone", @"Kamal", @"iPad", @"Bill" ];
NSNumber *shouldUseLiterals = [NSNumber numberWithBool:YES];NSNumber *buildingZIPCode = [NSNumber numberWithInteger:10018];

属性

1. 属性的命名使用小驼峰【M】

推荐这样写：

@property (nonatomic, readwrite, strong) UIButton *confirmButton;

2. 属性的关键字推荐按照原子性，读写，内存管理的顺序排列【M】

推荐这样写：

@property (nonatomic, readwrite,   copy) NSString *name;
@property (nonatomic, readonly,    copy) NSString *gender;
@property (nonatomic, readwrite, strong) UIView *headerView;

3. Block属性应该使用copy关键字【M】

推荐这样写：

typedef void (^ErrorCodeBlock) (id errorCode, NSString *message);
@property (nonatomic, readwrite, copy) ErrorCodeBlock errorBlock;//将block拷贝到堆中

4. 形容词性的BOOL属性的getter应该加上is前缀【S】

推荐这样写：

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

5. 使用getter方法做懒加载【S】

实例化一个对象是需要耗费资源的，如果这个对象里的某个属性的实例化要调用很多配置和计算，就需要懒加载它，在使用它的前一刻对它进行实例化：

- (NSDateFormatter *)dateFormatter {
    if (!_dateFormatter) {
        _dateFormatter = [[NSDateFormatter alloc] init];
        NSLocale *enUSPOSIXLocale = [[NSLocale alloc] initWithLocaleIdentifier:@"en_US_POSIX"];
        [_dateFormatter setLocale:enUSPOSIXLocale];
        [_dateFormatter setDateFormat:@"yyyy-MM-dd'T'HH:mm:ss.SSS"];
    } 
    return _dateFormatter;
}

但是也有对这种做法的争议：getter方法可能会产生某些副作用，例如如果它修改了全局变量，可能会产生难以排查的错误。

6. 除了init和dealloc方法，建议都使用点语法访问属性【M】

使用点语法的好处：

setter：

setter会遵守内存管理语义(strong, copy, weak)。
通过在内部设置断点，有助于调试bug。
可以过滤一些外部传入的值。
捕捉KVO通知。

getter：

允许子类化。
通过在内部设置断点，有助于调试bug。
实现懒加载（lazy initialization）。

注意：

懒加载的属性，必须通过点语法来读取数据。因为懒加载是通过重写getter方法来初始化实例变量的，如果不通过属性来读取该实例变量，那么这个实例变量就永远不会被初始化。

在init和dealloc方法里面使用点语法的后果是：因为没有绕过setter和getter，在setter和getter里面可能会有很多其他的操作。而且如果它的子类重载了它的setter和getter方法，那么就可能导致该子类调用其他的方法。

7. 不要滥用点语法，要区分好方法调用和属性访问【S】

推荐这样写：

view.backgroundColor = [UIColor orangeColor]; 
[UIApplication sharedApplication].delegate;

不推荐这样写：

[view setBackgroundColor:[UIColor orangeColor]]; 
UIApplication.sharedApplication.delegate;

8. 尽量使用不可变对象【S】

建议尽量把对外公布出来的属性设置为只读，在实现文件内部设为读写。具体做法是：

在头文件中，设置对象属性为

在实现文件中设置为readwrite。

这样一来，在外部就只能读取该数据，而不能修改它，使得这个类的实例所持有的数据更加安全。而且，对于集合类的对象，更应该仔细考虑是否可以将其设为可变的。

如果在公开部分只能设置其为只读属性，那么就在非公开部分存储一个可变型。所以当在外部获取这个属性时，获取的只是内部可变型的一个不可变版本,例如：

在公共API中：

@interface EOCPerson : NSObject

@property (nonatomic, copy, readonly) NSString *firstName;
@property (nonatomic, copy, readonly) NSString *lastName;
@property (nonatomic, strong, readonly) NSSet *friends //向外公开的不可变集合

*   (id)initWithFirstName:(NSString*)firstName andLastName:(NSString*)lastName;
*   (void)addFriend:(EOCPerson*)person;
*   (void)removeFriend:(EOCPerson*)person;

@end

在这里，我们将friends属性设置为不可变的set。然后，提供了来增加和删除这个set里的元素的公共接口。

在实现文件里：

@interface EOCPerson ()

@property (nonatomic, copy, readwrite) NSString *firstName;
@property (nonatomic, copy, readwrite) NSString *lastName;

@end

@implementation EOCPerson {
NSMutableSet *_internalFriends; //实现文件里的可变集合
}

- (NSSet*)friends {
    return [_internalFriends copy]; //get方法返回的永远是可变set的不可变型
    }

- (void)addFriend:(EOCPerson*)person {
    [_internalFriends addObject:person]; //在外部增加集合元素的操作
    //do something when add element
    }

- (void)removeFriend:(EOCPerson*)person {
    [_internalFriends removeObject:person]; //在外部移除元素的操作
    //do something when remove element
    }

- (id)initWithFirstName:(NSString*)firstName andLastName:(NSString*)lastName {

    if ((self = [super init])) {

    _firstName = firstName;
    _lastName = lastName;
    _internalFriends = [NSMutableSet new];

    }
    return self;
}

我们可以看到，在实现文件里，保存一个可变set来记录外部的增删操作。

这里最重要的代码是：

- (NSSet*)friends {
    return [_internalFriends copy];
    }

这个是friends属性的获取方法：它将当前保存的可变set复制了一不可变的set并返回。因此，外部读取到的set都将是不可变的

方法

1. 方法名中不应使用and，而且签名要与对应的参数名保持高度一致【M】

推荐这样

- (instancetype)initWithWidth:(CGFloat)width height:(CGFloat)height;

不推荐这样写：

- (instancetype)initWithWidth:(CGFloat)width andHeight:(CGFloat)height;
- (instancetype)initWith:(int)width and:(int)height;

2. 方法实现时，如果参数过长，则令每个参数占用一行，以冒号对齐。【S】

- (void)doSomethingWith:(NSString *)theFoo
                   rect:(CGRect)theRect
               interval:(CGFloat)theInterval
{
 //Implementation
}

3. 私有方法应该在实现文件中申明。【S】

@interface ViewController ()
- (void)basicConfiguration;
@end

@implementation ViewController
- (void)basicConfiguration
{
 //Do some basic configuration
}
@end

4. 方法名用小写字母开头的单词组合而成【M】

- (NSString *)descriptionWithLocale:(id)locale;

5. 方法名前缀【S】

刷新视图的方法名要以refresh为首。
更新数据的方法名要以update或者configure为首。

推荐这样写：

- (void)refreshHeaderViewWithCount:(NSUInteger)count;
- (void)updateDataSourceWithViewModel:(ViewModel *)viewModel;

面向协议编程

如果某些功能（方法）具备可复用性，我们就需要将它们抽取出来放入一个抽象接口文件中（在iOS中，抽象接口即协议），让不同类型的对象遵循这个协议，从而拥有相同的功能。

因为协议是不依赖于某个对象的，所以通过协议，我们可以解开两个对象之间的耦合。如何理解呢？我们来看一下下面这个例子：

现在有一个需求：在一个UITableViewController里面拉取feed并展示出来。

方案一：

定义一个拉取feed的类ZOCFeedParser，这个类有一些代理方法实现feed相关功能：

@protocol ZOCFeedParserDelegate <NSObject>

@optional
- (void)feedParserDidStart:(ZOCFeedParser *)parser;
- (void)feedParser:(ZOCFeedParser *)parser didParseFeedInfo:(ZOCFeedInfoDTO *)info; 
- (void)feedParser:(ZOCFeedParser *)parser didParseFeedItem:(ZOCFeedItemDTO *)item; 
- (void)feedParserDidFinish:(ZOCFeedParser *)parser;
- (void)feedParser:(ZOCFeedParser *)parser didFailWithError:(NSError *)error;@end 

@interface ZOCFeedParser : NSObject

@property (nonatomic, weak  ) id <ZOCFeedParserDelegate> delegate; 
@property (nonatomic, strong) NSURL *url; 

- (id)initWithURL:(NSURL *)url; 
- (BOOL)start; 
- (void)stop; 

@end

然后在ZOCTableViewController里面传入ZOCFeedParser，并遵循其代理方法，实现feed的拉取功能。

@interface ZOCTableViewController : UITableViewController<ZOCFeedParserDelegate>
- (instancetype)initWithFeedParser:(ZOCFeedParser *)feedParser; 
@end

具体应用：

NSURL *feedURL = [NSURL URLWithString:@"http://bbc.co.uk/feed.rss"]; 
ZOCFeedParser *feedParser = [[ZOCFeedParser alloc] initWithURL:feedURL]; 
ZOCTableViewController *tableViewController = [[ZOCTableViewController alloc] initWithFeedParser:feedParser]; 
feedParser.delegate = tableViewController;

OK，现在我们实现了需求：在ZOCTableViewController里面存放了一个ZOCFeedParser对象来处理feed的拉取功能。

但这里有一个严重的耦合问题：ZOCTableViewController只能通过ZOCFeedParser对象来处理feed的拉取功能。
于是我们重新审视一下这个需求：其实我们实际上只需要ZOCTableViewController拉取feed就可以了，而具体是由哪个对象来拉取，ZOCTableViewController并不需要关心。

也就是说，我们需要提供给ZOCTableViewController的是一个更范型的对象，这个对象具备了拉取feed的功能就好了，而不应该仅仅局限于某个具体的对象（ZOCFeedParser）。所以，刚才的设计需要重新做一次修改：

方案二：

首先需要在一个接口文件ZOCFeedParserProtocol.h里面定义抽象的，具有拉取feed功能的协议：

@protocol ZOCFeedParserDelegate <NSObject>

@optional
- (void)feedParserDidStart:(id<ZOCFeedParserProtocol>)parser;
- (void)feedParser:(id<ZOCFeedParserProtocol>)parser didParseFeedInfo:(ZOCFeedInfoDTO *)info; 
- (void)feedParser:(id<ZOCFeedParserProtocol>)parser didParseFeedItem:(ZOCFeedItemDTO *)item; 
- (void)feedParserDidFinish:(id<ZOCFeedParserProtocol>)parser;
- (void)feedParser:(id<ZOCFeedParserProtocol>)parser didFailWithError:(NSError *)error;

@end 

@protocol ZOCFeedParserProtocol <NSObject>

@property (nonatomic, weak) id <ZOCFeedParserDelegate> delegate; 
@property (nonatomic, strong) NSURL *url;

- (BOOL)start;
- (void)stop;

@end

而原来的ZOCFeedParser仅仅是需要遵循上面这个协议就具备了拉取feed的功能：

@interface ZOCFeedParser : NSObject <ZOCFeedParserProtocol> 
- (id)initWithURL:(NSURL *)url;//仅仅需要通过传入url即可，其他事情都交给ZOCFeedParserProtocol@end

而且，ZOCTableViewController也不直接依赖于ZOCFeedParser对象，我们只需要传给它一个遵循<ZOCFeedParserProtocol>的对象即可。

@interface ZOCTableViewController : UITableViewController <ZOCFeedParserDelegate>
- (instancetype)initWithFeedParser:(id<ZOCFeedParserProtocol>)feedParser;
@end

这样一来，ZOCTableViewController和ZOCFeedParser之间就没有直接的关系了。以后，如果我们想：

给这个feed拉取器增加新的功能：仅需要修改ZOCFeedParserProtocol.h文件。
更换一个feed拉取器实例：创建一个新类型来遵循ZOCFeedParserProtocol.h即可。

iOS 中委托的设计

1. 要区分好代理和数据源的区别【S】

在iOS开发中的委托模式包含了delegate（代理）和datasource（数据源）。虽然二者同属于委托模式，但是这两者是有区别的。这个区别就是二者的信息流方向是不同的：

delegate ：事件发生的时候，委托者需要通知代理。（信息流从委托者到代理）
datasource：委托者需要从数据源拉取数据。（信息流从数据源到委托者）

然而包括苹果也没有做好榜样，将它们彻底的区分开。就拿UITableView来说，在它的delegate方法中有一个方法：

- (void)tableView:(UITableView *)tableView didSelectRowAtIndexPath:(NSIndexPath *)indexPath;

这个方法正确地体现了代理的作用：委托者（tableview）告诉代理（控制器）“我的某个cell被点击了”。但是，UITableViewDelegate的方法列表里还有这个方法：

- (CGFloat)tableView:(UITableView *)tableView heightForRowAtIndexPath:(NSIndexPath *)indexPath;

该方法的作用是由控制器来告诉tabievlew的行高，也就是说，它的信息流是从控制器（数据源）到委托者（tableview）的。准确来讲，它应该是一个数据源方法，而不是代理方法。

在UITableViewDataSource中，就有标准的数据源方法：

- (NSInteger)numberOfSectionsInTableView:(UITableView *)tableView;

这个方法的作用就是让tableview向控制器拉取一个section数量的数据。

所以，在我们设计一个视图控件的代理和数据源时，一定要区分好二者的区别，合理地划分哪些方法属于代理方法，哪些方法属于数据源方法。

2. 代理方法的第一个参数必须为委托者【S】

代理方法必须以委托者作为第一个参数（参考UITableViewDelegate）的方法。其目的是为了区分不同委托着的实例。因为同一个控制器是可以作为多个tableview的代理的。若要区分到底是哪个tableview的cell被点击了，就需要在方法中做个区分

- (void)tableView:(UITableView *)tableView didSelectRowAtIndexPath:(NSIndexPath *)indexPath。

向代理发送消息时需要判断其是否实现该方法

最后，在委托着向代理发送消息的时候，需要判断委托着是否实现了这个代理方法:

if ([self.delegate respondsToSelector:@selector(signUpViewControllerDidPressSignUpButton:)]) { 
    [self.delegate signUpViewControllerDidPressSignUpButton:self]; 
}

3. 遵循代理过多的时候，换行对齐显示【S】

@interface ShopViewController () <UIGestureRecognizerDelegate,
                                  HXSClickEventDelegate,
                                  UITableViewDelegate,
                                  UITableViewDataSource>

4. 代理的方法需要明确必须执行和可不执行

代理方法在默认情况下都是必须执行的，然而在设计一组代理方法的时候，有些方法可以不是必须执行（是因为存在默认配置），这些方法就需要使用@optional关键字来修饰：

@protocol ZOCServiceDelegate <NSObject>
@optional
- (void)generalService:(ZOCGeneralService *)service didRetrieveEntries:(NSArray *)entries; 
@end

类

1. 类的名称应该以三个大或者两个写字母为前缀；创建子类的时候，应该把代表子类特点的部分放在前缀和父类名的中间【S】

推荐这样写：

//父类
ZOCSalesListViewController

//子类
ZOCDaySalesListViewController
ZOCMonthSalesListViewController

2. initializer && dealloc

2.1 dealloc方法里面应该直接访问实例变量，不应该用点语法访问【M】

2.2 init方法的写法：【M】

init方法返回类型必须是instancetype，不能是id。
必须先实现[super init]。

- (instancetype)init { 
 self = [super init]; // call the designated initializer 
 if (self) {
 // Custom initialization
 }
 return self;
}

2.3 指定初始化方法【S】

指定初始化方法(designated initializer)是提供所有的（最多的）参数的初始化方法，间接初始化方法(secondary initializer)有一个或部分参数的初始化方法。

注意事项1：间接初始化方法必须调用指定初始化方法。

@implementation ZOCEvent 

//指定初始化方法
- (instancetype)initWithTitle:(NSString *)title date:(NSDate *)date 
location:(CLLocation *)location
{ 
 self = [super init];
 if (self) {
    _title = title;
    _date = date;
    _location = location;
 }
 return self;
} 

//间接初始化方法
- (instancetype)initWithTitle:(NSString *)title date:(NSDate *)date
{ 
    return [self initWithTitle:title date:date location:nil];
}

//间接初始化方法
- (instancetype)initWithTitle:(NSString *)title 
{ 
    return [self initWithTitle:title date:[NSDate date] location:nil];
}

@end

注意事项2：如果直接父类有指定初始化方法，则必须调用其指定初始化方法

- (id)initWithNibName:(NSString *)nibNameOrNil bundle:(NSBundle *)nibBundleOrNil {
    self = [super initWithNibName:nibNameOrNil bundle:nibBundleOrNil]; 
    if (self) {
    }
    return self; 
}

注意事项3：如果想在当前类自定义一个新的全能初始化方法，则需要如下几个步骤

定义新的指定初始化方法，并确保调用了直接父类的初始化方法。
重载直接父类的初始化方法，在内部调用新定义的指定初始化方法。
为新的指定初始化方法写文档。

看一个标准的例子：

@implementation ZOCNewsViewController

//新的指定初始化方法
- (id)initWithNews:(ZOCNews *)news {
    self = [super initWithNibName:nil bundle:nil]; 
    if (self) {
    _news = news;
    }
    return self;
} 

// 重载父类的初始化方法
- (id)initWithNibName:(NSString *)nibNameOrNil bundle:(NSBundle *)nibBundleOrNil{
    return [self initWithNews:nil]; 
}
@end

在这里，重载父类的初始化方法并在内部调用新定义的指定初始化方法的原因是你不能确定调用者调用的就一定是你定义的这个新的指定初始化方法，而不是原来从父类继承来的指定初始化方法。

假设你没有重载父类的指定初始化方法，而调用者却恰恰调用了父类的初始化方法。那么调用者可能永远都调用不到你自己定义的新指定初始化方法了。

而如果你成功定义了一个新的指定初始化方法并能保证调用者一定能调用它，你最好要在文档中明确写出哪一个才是你定义的新初始化方法。或者你也可以使用编译器指令__attribute__((objc_designated_initializer))来标记它。

3. 所有返回类对象和实例对象的方法都应该使用instancetype【S】

将instancetype关键字作为返回值的时候，可以让编译器进行类型检查，同时适用于子类的检查，这样就保证了返回类型的正确性（一定为当前的类对象或实例对象）

推荐这样写：

@interface ZOCPerson
+ (instancetype)personWithName:(NSString *)name; 
@end

不推荐这样写：

@interface ZOCPerson
+ (id)personWithName:(NSString *)name; 
@end

4. 在类的头文件中尽量少引用其他头文件【S】

有时，类A需要将类B的实例变量作为它公共API的属性。这个时候，我们不应该引入类B的头文件，而应该使用向前声明（forward declaring）使用class关键字，并且在A的实现文件引用B的头文件。

// EOCPerson.h
#import <Foundation/Foundation.h>

@class EOCEmployer;

@interface EOCPerson : NSObject

@property (nonatomic, copy  ) NSString *firstName;
@property (nonatomic, copy  ) NSString *lastName;
@property (nonatomic, strong) EOCEmployer *employer;//将EOCEmployer作为属性

@end

// EOCPerson.m
#import "EOCEmployer.h"

这样做有什么优点呢：

不在A的头文件中引入B的头文件，就不会一并引入B的全部内容，这样就减少了编译时间。

可以避免循环引用：因为如果两个类在自己的头文件中都引入了对方的头文件，那么就会导致其中一个类无法被正确编译。

但是个别的时候，必须在头文件中引入其他类的头文件:

主要有两种情况：

该类继承于某个类，则应该引入父类的头文件。

该类遵从某个协议，则应该引入该协议的头文件。而且最好将协议单独放在一个头文件中。

5. 类的布局【S】

#pragma mark - Life Cycle Methods
- (instancetype)init
- (void)dealloc

- (void)viewWillAppear:(BOOL)animated
- (void)viewDidAppear:(BOOL)animated
- (void)viewWillDisappear:(BOOL)animated
- (void)viewDidDisappear:(BOOL)animated

#pragma mark - Override Methods

#pragma mark - Intial Methods

#pragma mark - Network Methods

#pragma mark - Target Methods

#pragma mark - Public Methods

#pragma mark - Private Methods

#pragma mark - UITableViewDataSource  
#pragma mark - UITableViewDelegate  

#pragma mark - Lazy Loads

#pragma mark - NSCopying  

#pragma mark - NSObject  Methods

分类

1. 分类添加的方法需要添加前缀和下划线【S】

推荐这样写：

@interface NSDate (ZOCTimeExtensions)
 - (NSString *)zoc_timeAgoShort;
@end

不推荐这样写：

@interface NSDate (ZOCTimeExtensions) 
- (NSString *)timeAgoShort;
@end

2. 把类的实现代码分散到便于管理的多个分类中【S】

一个类可能会有很多公共方法，而且这些方法往往可以用某种特有的逻辑来分组。我们可以利用Objecctive-C的分类机制，将类的这些方法按一定的逻辑划入几个分区中。

举个🌰：

先看一个没有使用无分类的类：

#import <Foundation/Foundation.h>

@interface EOCPerson : NSObject

@property (nonatomic, copy,   readonly) NSString *firstName;
@property (nonatomic, copy,   readonly) NSString *lastName;
@property (nonatomic, strong, readonly) NSArray *friends;

- (id)initWithFirstName:(NSString *)firstName andLastName:(NSString *)lastName;

/* Friendship methods */
- (void)addFriend:(EOCPerson *)person;
- (void)removeFriend:(EOCPerson *)person;
- (BOOL)isFriendsWith:(EOCPerson *)person;

/* Work methods */
- (void)performDaysWork;
- (void)takeVacationFromWork;

/* Play methods */
- (void)goToTheCinema;
- (void)goToSportsGame;

@end

分类之后：

#import <Foundation/Foundation.h>

@interface EOCPerson : NSObject

@property (nonatomic, copy,   readonly) NSString *firstName;
@property (nonatomic, copy,   readonly) NSString *lastName;
@property (nonatomic, strong, readonly) NSArray *friends;

- (id)initWithFirstName:(NSString *)firstName andLastName:(NSString *)lastName;

@end

@interface EOCPerson (Friendship)

- (void)addFriend:(EOCPerson *)person;
- (void)removeFriend:(EOCPerson *)person;
- (BOOL)isFriendsWith:(EOCPerson *)person;

@end

@interface EOCPerson (Work)

- (void)performDaysWork;
- (void)takeVacationFromWork;

@end

@interface EOCPerson (Play)

- (void)goToTheCinema;
- (void)goToSportsGame;

@end

其中，FriendShip分类的实现代码可以这么写：

// EOCPerson+Friendship.h
#import "EOCPerson.h"

@interface EOCPerson (Friendship)

- (void)addFriend:(EOCPerson *)person;
- (void)removeFriend:(EOCPerson *)person;
- (BOOL)isFriendsWith:(EOCPerson *)person;

@end

// EOCPerson+Friendship.m
#import "EOCPerson+Friendship.h"

@implementation EOCPerson (Friendship)

- (void)addFriend:(EOCPerson *)person {
 /* ... */
}

- (void)removeFriend:(EOCPerson *)person {
 /* ... */
}

- (BOOL)isFriendsWith:(EOCPerson *)person {
 /* ... */
}

@end

注意：在新建分类文件时，一定要引入被分类的类文件。

通过分类机制，可以把类代码分成很多个易于管理的功能区，同时也便于调试。因为分类的方法名称会包含分类的名称，可以马上看到该方法属于哪个分类中。

利用这一点，我们可以创建名为Private的分类，将所有私有方法都放在该类里。这样一来，我们就可以根据private一词的出现位置来判断调用的合理性，这也是一种编写“自我描述式代码（self-documenting）”的办法。

单例

1. 单例不能作为容器对象来使用【M】

单例对象不应该暴露出任何属性，也就是说它不能作为让外部存放对象的容器。它应该是一个处理某些特定任务的工具，比如在iOS中的GPS和加速度传感器。我们只能从他们那里得到一些特定的数据。

2. 使用dispatch_once来生成单例【M】

推荐这样写：

+ (instancetype)sharedInstance { 
     static id sharedInstance = nil; 
     static dispatch_once_t onceToken = 0;
     dispatch_once(&onceToken, ^{ 
        sharedInstance = [[self alloc] init];
     }); 
     return sharedInstance; 
}

不推荐这样写：

+ (instancetype)sharedInstance { 
    static id sharedInstance; 
    @synchronized(self) { 
        if (sharedInstance == nil) {  
            sharedInstance = [[MyClass alloc] init]; 
        } 
    } 
    return sharedInstance; 
}

相等性的判断【S】

判断两个person类是否相等的合理做法：

-  (BOOL)isEqual:(id)object {

    if (self == object) {  
        return YES; //判断内存地址
    } 
    if (![object isKindOfClass:[ZOCPerson class]]) { 
        return NO; //是否为当前类或派生类 
    } 
    
    return [self isEqualToPerson:(ZOCPerson *)object]; 
}

//自定义的判断相等性的方法
-  (BOOL)isEqualToPerson:(Person *)person { 
    if (!person) {  
        return NO;
    } 

    BOOL namesMatch = (!self.name && !person.name) || [self.name isEqualToString:person.name]; 
    BOOL birthdaysMatch = (!self.birthday && !person.birthday) || [self.birthday isEqualToDate:person.birthday];
    
    return haveEqualNames && haveEqualBirthdays; 
}

方法文档

一个函数(方法)必须有一个字符串文档来解释，除非它：

非公开，私有函数。
很短。
显而易见。

而其余的，包括公开接口，重要的方法，分类，以及协议，都应该伴随文档（注释）：

以/开始
第二行识总结性的语句
第三行永远是空行
在与第二行开头对齐的位置写剩下的注释。

建议这样写：

/* This comment serves to demonstrate the format of a doc string.

Note that the summary line is always at most one line long, and after the opening block comment,
and each line of text is preceded by a single space.
*/

看一个指定初始化方法的注释：

/ *
  *  Designated initializer. *
  *  @param store The store for CRUD operations.
  *  @param searchService The search service used to query the store. 
  *  @return A ZOCCRUDOperationsStore object.
  */ 
- (instancetype)initWithOperationsStore:(id<ZOCGenericStoreProtocol>)store searchService:(id<ZOCGenericSearchServiceProtocol>)searchService;

多用队列，少用同步锁来避免资源抢夺【S】

多个线程执行同一份代码时，很可能会造成数据不同步。建议使用GCD来为代码加锁的方式解决这个问题。

方案一：使用串行同步队列来将读写操作都安排到同一个队列里：

_syncQueue = dispatch_queue_create("com.effectiveobjectivec.syncQueue", NULL);

//读取字符串
- (NSString*)someString {

    __block NSString *localSomeString;
    dispatch_sync(_syncQueue, ^{
        localSomeString = _someString;
    });

    return localSomeString;

}

//设置字符串
- (void)setSomeString:(NSString *)someString {

    dispatch_sync(_syncQueue, ^{
        _someString = someString;
    });
}

这样一来，读写操作都在串行队列进行，就不容易出错。

但是，还有一种方法可以让性能更高：

方案二：将写操作放入栅栏快中，让他们单独执行；将读取操作并发执行。

_syncQueue = dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0);

//读取字符串
- (NSString*)someString {

     __block NSString *localSomeString;
     dispatch_sync(_syncQueue, ^{
        localSomeString = _someString;
    });
     return localSomeString;
}

//设置字符串
- (void)setSomeString:(NSString*)someString {

     dispatch_barrier_async(_syncQueue, ^{
        _someString = someString;
    });
}

显然，数据的正确性主要取决于写入操作，那么只要保证写入时，线程是安全的，那么即便读取操作是并发的，也可以保证数据是同步的。
这里的dispatch_barrier_async方法使得操作放在了同步队列里“有序进行”，保证了写入操作的任务是在串行队列里。

实现description方法打印自定义对象信息【S】

在打印我们自己定义的类的实例对象时，在控制台输出的结果往往是这样的：object = <EOCPerson: 0x7fd9a1600600>

这里只包含了类名和内存地址，它的信息显然是不具体的,远达不到调试的要求。

但是！如果在我们自己定义的类覆写description方法，我们就可以在打印这个类的实例时输出我们想要的信息。

例如：

- (NSString*)description {
     return [NSString stringWithFormat:@"<%@: %p, %@ %@>", [self class], self, firstName, lastName];
}

在这里，显示了内存地址，还有该类的所有属性。

而且，如果我们将这些属性值放在字典里打印，则更具有可读性：

- (NSString*)description {

     return [NSString stringWithFormat:@"<%@: %p, {\n%@\n}",[self class],self,
    @{ @"title":_title,
       @"latitude":@(_latitude),
       @"longitude":@(_longitude)}
    ];
}

输出结果：

location = <EOCLocation: 0x7f98f2e01d20, {
   latitude = "51.506";
   longitude = 0;
   title = London;
}

我们可以看到，通过重写description方法可以让我们更加了解对象的情况，便于后期的调试，节省开发时间。

Tips：在lldb处于断点状态时，可以重写debugDescription方法改变debug时输出样式

NSArray& NSMutableArray

1. addObject之前要非空判断。

2. 取下标的时候要判断是否越界。

3. 取第一个元素或最后一个元素的时候使用firtstObject和lastObject

NSCache

1. 构建缓存时选用NSCache 而非NSDictionary【S】

如果我们缓存使用得当，那么应用程序的响应速度就会提高。只有那种“重新计算起来很费事的数据，才值得放入缓存”，比如那些需要从网络获取或从磁盘读取的数据。

在构建缓存的时候很多人习惯用NSDictionary或者NSMutableDictionary，但是作者建议大家使用NSCache，它作为管理缓存的类，有很多特点要优于字典，因为它本来就是为了管理缓存而设计的。

2. NSCache优于NSDictionary的几点：

当系统资源将要耗尽时，NSCache具备自动删减缓冲的功能。并且还会先删减“最久未使用”的对象。
NSCache不拷贝键，而是保留键。因为并不是所有的键都遵从拷贝协议（字典的键是必须要支持拷贝协议的，有局限性）。
NSCache是线程安全的：不编写加锁代码的前提下，多个线程可以同时访问NSCache。

iOS 图片命名规范【S】

参考: iOS 图片命名规范

git提交

提交的commit必须能通过编译不能有error和多余的警告【M】
commit message 应该清晰明了，说明本次提交的目的【M】

NSNotification

1. 通知的名称【M】

建议将通知的名字作为常量，保存在一个专门的类中：

// Const.h
extern NSString * const ZOCFooDidBecomeBarNotification

// Const.m
NSString * const ZOCFooDidBecomeBarNotification = @"ZOCFooDidBecomeBarNotification";

2. 通知的注册【M】

注册通知建议是在 - (void)viewDidLoaded进行，特殊情况可以在- (void)viewWillAppear:,此时必须在- (void)viewWillDisappear:成对调用

3. 通知的移除【M】

通知必须要在对象销毁之前移除掉。

其他

1. 尽量采用MVC架构，使用fram或者Masonry布局。【S】

文件按照Model View Controller Cell Other来组织

2. Xcode工程文件的物理路径要和逻辑路径保持一致。【S】

3. 忽略没有使用变量的编译警告【S】

对于某些暂时不用，以后可能用到的临时变量，为了避免警告，我们可以使用如下方法将这个警告消除：

- (NSInteger)giveMeFive { 
 NSString *foo; 
 #pragma unused (foo) 
 return 5; 
}

4. 手动标明警告和错误【S】

手动明确一个错误：

- (NSInteger)divide:(NSInteger)dividend by:(NSInteger)divisor { 
 #error Whoa, buddy, you need to check for zero here! 
 return (dividend / divisor); 
}

手动明确一个警告：

- (float)divide:(float)dividend by:(float)divisor { 
 //#warning Dude, don't compare floating point numbers like this! 
    if (divisor != 0.0) { 
        return (dividend / divisor); 
    } else {  
        return NAN; 
    } 
}

iOS编码规范

概览

一. 核心原则【M】

原则一：简洁性原则--代码应该简洁易懂，逻辑清晰

原则二：可拓展性--面向变化编程，而不是面向需求编程。

原则三：效率优先--先保证程序的正确性，防止过度工程

二. 通用规范

格式【M】

大括号【S】

运算符

1. 运算符与变量之间的间隔

1.1 一元运算符与变量之间没有空格【M】：

1.2 二元运算符与变量之间必须有空格【M】

2. 多个不同的运算符同时存在时应该使用括号来明确优先级【M】

变量

1. 一个变量有且只有一个功能，尽量不要把一个变量用作多种用途【M】

2. 变量在使用前应初始化，防止未初始化的变量被引用【M】

3. 局部变量应该尽量接近使用它的地方【S】

if语句

1. 必须列出所有分支（穷举所有的情况），而且每个分支都必须给出明确的结果。【S】

2. 不要使用过多的分支，要善于使用return来提前返回错误的情况【M】

3. 条件表达式如果很长，则需要将他们提取出来赋给一个BOOL值【M】

4. 条件语句的判断应该是变量在左，常量在右【S】

5. 每个分支的实现代码都必须被大括号包围【S】

6. 条件过多，过长的时候应该换行【S】

for语句

1. 不可在for循环内修改循环变量，防止for循环失去控制。【M】

2. 避免使用continue和break。【S】

2.1 如果出现了continue，只需要把continue的条件取反即可

2.2 消除while里的break：将break的条件取反，并合并到主循环里

2.3 在有返回值的方法里消除break：将break转换为return立即返回

Switch语句

1. 每个分支都必须用大括号括起来，每个case太长建议后面空一行再写下一个case【S】

2. 使用枚举类型时，不能有default分支， 除了使用枚举类型以外，都必须有default分支【M】

函数

1. 一个函数的长度必须限制在80行以内，建议50行以内【M】

2. 一个函数只做一件事（单一原则）【M】

3. 对于有返回值的函数（方法），每一个分支都必须有返回值【S】

4. 对输入参数的正确性和有效性进行检查，参数错误立即返回【S】

5. 如果在不同的函数内部有相同的功能，应该把相同的功能抽取出来单独作为另一个函数【S】

6. 将函数内部比较复杂的逻辑提取出来作为单独的函数【S】

8. 避免使用全局变量，类成员（class member）来传递信息，尽量使用局部变量和参数。【M】

注释规范

解释实现文件中复杂的逻辑

对代码进行标注

对接口进行说明

通用二级标签

Code Review

三. iOS规范

变量

1. 变量名必须使用驼峰格式【M】

2. 变量的名称必须同时包含功能与类型【S】

3. 系统常用类作实例变量声明时加入后缀【S】

常量

1. 常量以相关类名作为前缀【S】

2. 建议使用类型常量，不建议使用#define预处理命令【S】

3. 对外公开某个常量：【M】

宏

1. 宏、常量名都要使用大写字母，用下划线‘_’分割单词。【S】

2. 宏定义中如果包含表达式或变量，表达式和变量必须用小括号括起来。

CGRect函数

范型

Block

字面量

属性

1. 属性的命名使用小驼峰【M】

2. 属性的关键字推荐按照 原子性，读写，内存管理的顺序排列【M】

3. Block属性应该使用copy关键字 【M】

4. 形容词性的BOOL属性的getter应该加上is前缀【S】

5. 使用getter方法做懒加载 【S】

6. 除了init和dealloc方法，建议都使用点语法访问属性【M】

setter：

getter：

7. 不要滥用点语法，要区分好方法调用和属性访问【S】

8. 尽量使用不可变对象【S】

方法

1. 方法名中不应使用and，而且签名要与对应的参数名保持高度一致【M】

2. 方法实现时，如果参数过长，则令每个参数占用一行，以冒号对齐。【S】

3. 私有方法应该在实现文件中申明。【S】

4. 方法名用小写字母开头的单词组合而成【M】

2. 使用枚举类型时，不能有default分支，除了使用枚举类型以外，都必须有default分支【M】

2. 属性的关键字推荐按照原子性，读写，内存管理的顺序排列【M】

3. Block属性应该使用copy关键字【M】

5. 使用getter方法做懒加载【S】

2.1 dealloc方法里面应该直接访问实例变量，不应该用点语法访问【M】