iOS代码规范

关于初始化方法《iOS代码规范：初始化方法》可以看这篇文章

头文件

头文件要写详细⼀一点注释，特别是⼯工具类，要详细说明其作⽤用，关联业务，注意事项

导入需要使用到的其他class头文件，头文件按类型分类

// controller
#import “TextSelectionViewController.h"
// model
#import "PayPasswordUpdateModel.h"
#import "WalletModel.h"
// views
#import "PayPasswordAlertView.h"

类名

类的名称应该以三个大写字母为前缀
大写驼峰式命名。每个单词首字母大写。比如「申请记录控制器」ApplyRecordsViewController
每个类型的命名以该类型结尾。
ViewController：使用 ViewController 结尾。例子：ApplyRecordsViewController
View：使用 View 结尾。例子：分界线：boundaryView
NSArray：使用 s 结尾。比如商品分类数据源。categories
UITableViewCell：使用 Cell 结尾。比如 MyProfileCell
Protocol：使用 Delegate 或者 Datasource 结尾。比如 XQScanViewDelegate
Tool：工具类
代理类：Delegate
Service 类：Service
创建子类的时候，应该把代表子类特点的部分放在前缀和父类名的中间。

//父类
ZOCSalesListViewController

//子类
ZOCDaySalesListViewController
ZOCMonthSalesListViewController

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

// EOCPerson.h
#import 

@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的全部内容，这样就减少了编译时间。

在类声明中包含多个protocal，每个protocal占用一行

@interface ShopViewController ()

方法

方法与方法之间间隔一行
方法最后面的括号需要另起一行。遵循 Apple 的规范；对于其他场景的括号，括号不需要单独换行。比如 if 后面的括号
如果方法参数过多过长，建议多行书写。用冒号进行对齐

- (instancetype)init
{
    self = [super init];
    if (self) {
        <#statements#>
    }
    return self;
}

- (void)doHomework:(NSString *)name
            period:(NSInteger)second
            score:(NSInteger)score;

一个方法内的代码最好保持在50行以内，一般经验来看如果一个方法里面的代码行数过多，代码的阅读体验就很差（别问为什么，做过重构代码行数很长的人都有类似的心情）
一个函数只做一个事情，做到单一原则。所有的类、方法设计好后就可以类似搭积木一样实现一个系统。
对于有返回值的函数，且函数内有分支情况。确保每个分支都有返回值
函数如果有多个参数，外部传入的参数需要检验参数的非空、数据类型的合法性，参数错误做一些措施：立即返回、断言
多个函数如果有逻辑重复的代码，建议将重复的部分抽取出来，成为独立的函数进行调用
方法如果有多个参数的情况下需要注意是否需要介词和连词。很多时候在不知道如何抉择测时候思考下苹果的一些 API 的方法命名

//good
- (instancetype)initWithAge:(NSInteger)age name:(NSString *)name;

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


//bad
- (instancetype)initWithAge:(NSInteger)age andName:(NSString *)name;

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

方法调用沿用声明方法的习惯

[self doSomethingWith:@"test" rect:self.view.frame interval:1.0f];

[self doSomethingWith:@"test"
                 rect:self.view.frame
             interval:1.0f];

属性

对外尽量使用不可变对象
尽量把对外公布出来的属性设置为只读，在实现文件内部设为读写。具体做法是：
在头文件中，设置对象属性为readonly。在实现文件中设置为readwrite。

这样一来，在外部就只能读取该数据，而不能修改它，使得这个类的实例所持有的数据更加安全。而且，对于集合类的对象，更应该仔细考虑是否可以将其设为可变的。
如果在公开部分只能设置其为只读属性，那么就在非公开部分存储一个可变型。所以当在外部获取这个属性时，获取的只是内部可变型的一个不可变版本,例如：

@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;
}

这里最重要的代码是：

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

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

属性应该尽可能描述性地命名，避免缩写，并且是小写字母开头的驼峰命名

例:NSString *text;   不要这样 : NSString* text;NSString * text;
@property (nonatomic, strong) UITableView *tableView;
@property (nonatomic, assign, readonly) BOOL loading;   
@property (nonatomic, weak) id<#delegate#> delegate;
@property (nonatomic, copy) <#returnType#> (^<#Block#>)(<#parType#>);

条件表达式

当有条件过多、过长的时候需要换行，为了代码看起来整齐些

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

在一个代码块里面有个可能的情况时善于使用 return 来结束异常的情况

- (void)doHomework
{
    if (self.hungry) {
        return;
    }
    if (self.thirsty) {
        return;
    }
    if (self.tired) {
        return;
    }
}

每个分支的实现都必须使用 {} 包含。

// bad
if (self.hungry) self.eat() 
// good
if (self.hungry) {
    self.eat()
}

条件判断的时候应该是变量在左，条件在右。 if ( currentCursor == 2 ) { //... }
switch 语句后面的每个分支都需要用大括号括起来
switch 语句后面的 default 分支必须存在，除非是在对枚举进行 switch

switch (menuType) {  
  case menuTypeLeft: {
    // ...  
    break; 
   }
  case menuTypeRight: {
    // ...  
    break; 
  }
  case menuTypeTop: {
    // ...  
    break; 
  }
  case menuTypeBottom: {
    // ...  
    break; 
  }
}

变量命名

做到⻅见名知意
一个变量有且只有一个功能，尽量不要把一个变量用作多种用途
变量的名称必须同时包含功能与类型

UIButton *addBtn 
UILabel *nameLbl 
NSString *addressStr

系统常用类作实例变量声明时加入后缀

系统常用类作实例变量声明时加入后缀.png

注释

YES upon success; NO upon failure ---- 成功返回YES 失败返回NO

类的注释写在当前类文件的顶部
对于属性的注释建议写在属性上面，用的时候，会有提示功能

/// 刷新按钮
@property (nonatomic, strong) UIButton *refreshBtn;

对于 .h 文件中方法的注释，一律按快捷键 command+option+/。三个快捷键解决。按需在旁边对方法进行说明解释、返回值、参数的说明和解释
对于.m文件中方法的注释，在方法的上边或右边添加//，注释符和注释内容需要间隔一个空格。

// load network data

功能注释
版本迭代中，在同事写的代码基础上开发，一定要写上版本功能注释，方便询问具体功能

// 这是一个新加的功能 v5.20.0 by minjing.lin  2019-03-20 18:00

宏定义

尽量量少⽤用宏来定义具体类型的数据，可以改⽤用static NSString* const kMsg = @”MSG”等来表示;
字⺟母全⼤大写，单词与单词之间用_分割
采⽤用驼峰法命名(首字母大写)

#define HOME_PAGE_DID_SCROLL @"com.xq.home.page.tableview.did.scroll"
#define KHomePageDidScroll @"com.xq.home.page.tableview.did.scroll"

图片资源命名

单个文件的命名

文件资源的命名也需要一定的规范
命名规范：不能有中文、大写、特殊符号、空白
形式为：功能模块名类别功能状态@nx.png
[email protected]
[email protected]
万能公式：类别功能模块页面名称状态.png
[email protected]

资源的文件夹命名
最好也参考 App 按照功能模块建立对应的实体文件夹目录，最后到对应的目录下添加相应的资源文件。

版本规范

采用 A.B.C 三位数字命名，比如：1.0.2，当有更新的情况下按照下面的依据

版本规范.png

注意事项

使⽤用block时，如果block被单例例持有，则block内的self应使⽤用弱引⽤用
函数（方法）块之间使用一个空行分隔
对输入参数的正确性和有效性进行检查

Xcode 代码块的存放地址

~/Library/Developer/Xcode/UserData/CodeSnippets

Xcode文件模版的存放地址

/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/Library/Xcode/Templates/File Templates/

一元运算符与变量之间没有空格：

!aValue
-aValue  //负号
~aValue  //位非
++iCount
*strSource

169910077b339250.jpeg

参考1
参考2
规范