iOS开发规范文档

2018-04-03 本文已影响30人若小北00

此文档根据apple，google以及行业中比较知名的OC编码规范整理归纳而成，旨在为大家的iOS开发规范提供一份简单，统一的执行标准。

1、格式和换行

使用Xcode默认的设置使用4个空格来缩进。
- 在 Xcode > Preferences > Text Editing 将 Tab 和自动缩进都设置为 4 个空格
80个字数限制，每一行的代码尽量不要超出80个字的长度，超出的回车排版，方法名的冒号对齐
- xcode设置屏幕左上角Xode->Perference->Text Editing->"Page guide at column: 80" 打上勾
方法-和方法+和返回值前面的左括号间隔一个空格，方法参数直接间隔一个空格。
条件语句的格式采用苹果推荐的代码缩进方式。

2、命名规范

基本原则
- 命名统一使用驼峰命名法，以清晰为主、简洁为辅，尽量使用单词的全称，所有命名和规范都应尽可能的与苹果API保持一致，
- 例如枚举常量方法名的定义。
类命名
- 首字母大写，每个单词首字母大写
- 尽量使用能够反映类功能的名词短语
- 例如： UserManage ,UserData等
分类（类别）命名
- 与类命名相同，此外需添加要扩展的类名"+"
- eg： NSString+Login UIView+XIB 等
协议（委托）命名
- 与类命名相同，此外需添加“Delegate”后缀
- eg： UserManager 对应 UserManagerDelegate
方法命名
- 首字母小写，之后每个单词首字母都大写
- 方法名使用动词短语，一些经典的操作应该使用约定的动词
- “-” 号后面有个空格
- 传递参数的类型如果是指针，类与*号之间有空格
- 重载系统方法的时候，如无特殊情况均需要先调用super的方法。
- 例如：initWith,insert,remove,replace,add等等
方法参数命名
- 首字母小写，之后每个单词首字母都大写
- 具有足够的说明性
- 不需要添加类型前缀
- 例如： - (void) setUserData:(NSDictionary *)userInfo

变量命名

首字母小写，之后每个单词首字母都大写
具有足够的说明性
成员变量添加“_”前缀
例如： NSMutableDictionary *_dataDic;
如果该变量是属性不需要添加“_”
例如：

    @property (nonatomic, strong) NSDictionary *dataDic;
    @property (nonatomic, copy) TestBlock testBlock;
    @property (nonatomic, assigh) NSinteger num;
    @property (nonatomic, weak) id<delegate> delegate;

控件类型直接使用尾端的驼峰单词：
例如：

    UViewController -> xxxViewController 
    UIButton -> xxxButton 
    UILabel -> xxxLabel 
    UIImageView -> xxxImageView 
    UITableViewCell -> xxxCell 
    UIAlertView -> xxxAlertView 
    UIScrollView -> xxxScrollView

    以下当属性名过长，可以把属性类型缩写作为尾端
    UIButton -> xxxBtn 
    UIImage -> xxxImg
    UILabel -> xxxL

常量

常量（预定义，局部常量等）使用小写k开头的驼峰法
例如:#define kSpace 20
枚举类型参考系统API统一使用typedef NS_ENUM(类型, 名称)
例如：下面是系统的 UISearchBarStyle 的枚举定义的方式

typedef NS_ENUM(NSUInteger, UISearchBarStyle) {
     UISearchBarStyleDefault,    // currently UISearchBarStyleProminent
     UISearchBarStyleProminent,  // used my Mail, Messages and Contacts
     UISearchBarStyleMinimal     // used by Calendar, Notes and Music
}

图片命名
- 使用英文，全部小写，单词中间"_"隔开
- 添加UI模块名作为前缀，避免冲突
- 图片存放在 Images.xcassets 相关模块下下
- 例如： home_search_img
注释
- 单行注释：在方法的地方按 Command+/
- 标注的功能，快捷键是Command + Option + /
- 需要在方法名的上面（空白）的地方按 Command + Option + / 才管用
- 方法名需要在.h文件中多行注释方法和参数详情
- 文件下的方法区域分类，使用#pragma mark -，可以把在文件路径下的方法分类并标记
- 例如：#pragma mark - delegate
宏必须使用大写命名，"_"隔开
- 例如：SCREEN_WIDTH

3、代码优化

避免相同的代码段出现在多个地方，相同的代码，必须归纳出来用一个方法或者类封装起来
语句嵌套层次不得超过3层，超出的必须抽取出中间函数。例如：for，while循环 if，do等
及时删除或注释掉无用的代码，删除没有意义的注释
确定不使用的代码应该删除
及时清除警告
所有方法与方法之间空1行
所有代码块之间空1行

4. 头文件.h 执行文件.m

.h文件
- 所有的property 需要给出注释
- 所有自定义的方法需要给出注释
- 尽量减少公开的api接口数量
- import "xxxx.h" 部分头文件时候，如果只是内部使用，请放在.m文件下，.h使用@class xxxx 声明该类即可
- 文件下有声明代理，把@protocol代理放在@interface 上面
- 代理方法必须包含该类名
- 例如：
```
    @class ImageOperation; 
    @protocol ImageOperationDelegate<NSObject> 
    - (void) operation:(ImageOperation *)op didLoadImage:(UIImage *)image; 
    @end 
    @interface ImageOperation : NSOperation 
    @end
```
.m文件
- @implementation ViewController 上方使用 @interface ViewController() @end
- 使用部分代理，并且代理不被外部使用，请把他们都放在.m的interface ()下
- 所有自定义的方法需要给出注释
- 比较大的代码块需要给出注释
- 所有代码中出现的阿拉伯数字需要给出注释
- 程序中出现加密／解密逻辑的操作地方，需要给出注释说明过程（无论是系统还是自定义）

单例模式

单例对象应该使用线程安全模式来创建共享实例。

+ (instancetype)sharedInstance {
    static id sharedInstance = nil;

    static dispatch_once_t onceToken;
     dispatch_once(&onceToken, ^{
    sharedInstance = [[self alloc] init];
     });

    return sharedInstance;
}

参考文档

https://www.jianshu.com/p/23536482c194
https://github.com/NYTimes/objective-c-style-guide
https://github.com/raywenderlich/objective-c-style-guide#language

iOS开发规范文档

1、格式和换行

2、命名规范

3、代码优化

4. 头文件.h 执行文件.m

参考文档

猜你喜欢

热点阅读