iOS组项目规范

目前技术部iOS组，项目架构松散，底层混乱，缺少规范，导致团队开发时代码风格迥异。为了避免后期因为代码质量问题的重构，方便项目后期的维护。特写下此规范，望各位组员在写项目的时候，尽量按照此规范进行编写。

一.框架规范

框架规范按照下图进行一一讲解。

屏幕快照 2017-08-01 下午3.45.57.png

1. 项目入口

存放AppDelegate ，如AppDelegate内容过多，可分多个类文件进行编写；如：

屏幕快照 2017-08-01 下午4.00.06.png

2. 项目功能模块

项目需要开发人员编写的代码都主要集中在这一块。如图：

屏幕快照 2017-08-01 下午4.03.41.png

在此模块下的文件夹，主要以tarbar的标签进行分类。模块下，以MVC模式进行模块的编写，如：Home(首页)，里面分为4个文件夹:controller,model,view,others。

屏幕快照 2017-08-01 下午4.09.34.png

即:项目还是以传统的MVC模式进行开发。

3. 父类模块

学过编程的都知道，面向对象的三大特性：继承性，封装性，多态性。父类模块是为了减少代码的重复量而存在的。举个简单的例子，大家在自定义View的时候都经常写这样的代码:

- (instancetype)initWithFrame:(CGRect)frame
{
    self = [super initWithFrame:frame];
    if (self) {
        [self step];
    }
    return self;
}
- (void)step{
    // 添加自定义view里面的UI组件
}

每个自定义类都需要重复写这一端代码，非常的麻烦。这是可以把它写到一个父类上，在进行UIView的自定义的时候，只需要调用- (void)step即可。

例子如下：
（1）创建父类文件，继承自UIView。

屏幕快照 2017-08-01 下午4.22.43.png

(2) 在ParentView.h 文件声明- (void)step方法。

#import <UIKit/UIKit.h>

@interface ParentView : UIView
- (void)step;
@end

(3)ParentView.m文件代码如下:

#import "ParentView.h"

@implementation ParentView
- (instancetype)initWithFrame:(CGRect)frame
{
    self = [super initWithFrame:frame];
    if (self) {
        [self step];
    }
    return self;
}
- (void)step{
    
}

@end

当需要编写自定义UIView的时候，只需要继承自 ParentView，调用 - (void)step方法即可。代码如下:
(1)HomeHeardView.h的代码:

#import "ParentView.h"
#import "NameModel.h"
@interface HomeHeardView : ParentView
@property(nonatomic,strong)NameModel *nameModel;
@end

(2)HomeHeardView.m的代码:

#import "HomeHeardView.h"

@interface HomeHeardView()
@property(nonatomic,strong)UILabel *nameLabel;
@end

@implementation HomeHeardView
-(void)step{
    self.nameLabel = [UILabel new];
    self.nameLabel.backgroundColor = [UIColor redColor];
    self.nameLabel.textColor = [UIColor colorWithHexString:@"#4a4a4a"];
    [self addSubview:self.nameLabel];
    [self.nameLabel mas_makeConstraints:^(MASConstraintMaker *make) {
        make.center.equalTo(self);
        make.size.mas_equalTo(CGSizeMake(300, 100));
    }];
}
-(void)setNameModel:(NameModel *)nameModel{
    self.nameLabel.text = nameModel.name;
}
@end

可以看到，我不再需要重写- (instancetype)initWithFrame:(CGRect)frame方法。

4.管理模块

管理模块就是用来管理项目全局的设置和服务的，如:IM聊天部分的设备登录踢出管理，用户的登录登出的管理,一般都以单例来进行实现。
管理模块在目前开发的享见乐讯项目中，并没有体现出来，但是我在项目中有写过，使用单例模式写的UserData类。此类主要是用来对用户的管理。所以项目中的此类应该命名为UserManager才合适。

5.全局宏定义模块

存放所有宏定义的文件，在这里，建议所有的宏定义模块还是按照，不同的类别，编写在不同的文件当中。
如:对url的宏定义单独放在UrlMacro.h文件中。对一些第三方需要到的key的宏定义单独放在KeyMacro.h文件中。

6.第三方模块

存放所有的第三方库(自己手动导入的)以及对自己第三方库的封装的类。如享见乐讯项目的：TheAFNetWorking 类，YXPMBProgressView 类都可以放在此文件夹下。

7.工具类模块

存放所有工具类的文件。如：享见乐讯项目中使用的,用来转化RGB颜色的工具类UIColor+Hex；用来防止网络请求数据返回的数据为空的时候，UI控件显示“null”字样的工具类allCanUser;

屏幕快照 2017-08-01 下午5.17.31.png

8.资源模块

存放项目所需用到的图片，其他资源文件。

二.命名规范

1.命名原则：

(1)最少字符，尽量的减少命名对象的长度，选择字符少的名词

(2)名符其实，命名应该能直观的描述被命名对象是什么或者做什么

(3)避免歧义，尽量不要采用多义词，也不要使用命名组合之后产生多义的方式

(4)上下文一致，比如谓词的统一性，如果都是集合类，那么使用Remove表示删除操作，那么所有上下文就应该都用这个Remove，而不要再用Delete

(5)少用缩写，除非是很常见的缩写或者项目中定义好的缩写，否则不要使用缩写

(6)优先使用全局常量而非宏，应使用static方式声明常量；

（7）全部使用英文单词进行命名，禁止使用拼音，更不要使用拼音加英文双搭。

（8）类名开头不要简写，如HomeViewController写出：HViewController。

2.类命名

遵循命名原则，使用大驼峰法命名(每个单词首字母大写)，通常在类的头部.h文件添加类注释，标明该类的用途。

屏幕快照 2017-08-01 下午5.42.32.png

3.属性命名

1. 一般变量名使用小驼峰命名规则，不要使用下划线。
2. 类属性变量用小驼峰法。
3. 类的成员变量用小驼峰命名法并加上下划线开头的方式命名。

4.方法命名

使用小驼峰法命名，方法名使用动词短语，能具体表达出该方法的功能，参照系统方法：

- (NSInteger)tableView:(UITableView *)tableView numberOfRowsInSection:(NSInteger)section {
#warning Incomplete implementation, return the number of rows
    return 0;
}

三.注释规范

1.单行注释

使用 // 注释单行代码，最常见的使用场景是在方法内注释某个属性或某块区域的含义：

  //使用Masonry给nameLabel进行AutoLayout布局
    [self.nameLabel mas_makeConstraints:^(MASConstraintMaker *make) {
        make.center.equalTo(self);
        make.size.mas_equalTo(CGSizeMake(300, 100));
    }];

2.多行注释

使用 /** 文本 **/ 的注释格式（快捷键cmd+alt+/）可以对属性和类以及方法进行注释，与//不同的是，该注释方式可以写多行，一般使用在类的头文件，多行介绍当前类的含义，如下:

/**
 首页
 */
@interface HomeViewController : UIViewController

@end

3. 方法注释

与方法2相同，使用 /** 文本 **/ 的注释格式（快捷键cmd+alt+/）可以对方法进行注释，快捷键会根据方法参数自动生成需要填写的注释内容，并且在其他地方使用该方法时，Xcode会智能提示出之前写的注释内容:

/**
 设置显示的cell的行数的方法

 @param tableView cell所属的行
 @param section cell所属的组
 @return 返回行数
 */
- (NSInteger)tableView:(UITableView *)tableView numberOfRowsInSection:(NSInteger)section {
#warning Incomplete implementation, return the number of rows
    return 0;
}

4.方法集注释

先为了快速定位类中的某块代码，或某个方法，Xcode为我们提供了方法集的注释方式，可大大减少搜寻目标代码的时间。如下：

#pragma mark - Table view data source

- (NSInteger)numberOfSectionsInTableView:(UITableView *)tableView {
#warning Incomplete implementation, return the number of sections
    return 0;
}

为了更加方便的找到项目中的方法，在某个类文件的代码较多情况下，请使用代码集注释。
同时，某个代码集的注释，不要乱注释，如：#pragma mark - Table view data source写
Table view delegate的代码。

5.warning注释

在项目因为赶时间代码没有进行优化的情况下，请使用warning进行注释。赶工完之后，进行优化，去掉warning注释。

结语

因本人技术有限，项目的经验不足等，对构架的理解浅薄等原因，这个规范有很多不足的地方，望各位技术部的同事和iOS组的组员给我提出建议和意见。