iOS开发规范文档

作者: 若小北00 | 来源:发表于2018-04-03 14:20 被阅读30次

此文档根据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开发规范文档

    移动端iOS开发规范文档 序言 根据网上的一些OC编码规范整理归纳而成,为了利于项目维护以及规范开发,促进成员之间...

  • 移动端iOS开发规范文档

    移动端iOS开发规范文档 目录 格式与换行 命名 Objective-C下的cocoa编码规范 注释要求 其他 参...

  • iOS开发规范文档

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

  • iOS 开发文档规范

    iOS 开发文档规范 Method 命名驼峰类前缀使用三个字符,避开2个字符的NS,UI,CG,CF,CA,WK,...

  • iOS开发规范文档

    命名原则 1.基本原则 (1)清晰。 命名应该是以清晰为主、简洁为辅。总的来讲不要使用单词的简写,除了使用非常常见...

  • IOS 开发规范文档

    版权声明:本文为博主原创文章,未经博主允许不得转载。转载请注明转至Z.MJun的简书 1. 每一行的字数限制 80...

  • iOS开发规范文档

    1文件组织结构 1.1结构说明 1)iOS工程文件结构分物理结构(controller) 和逻辑结构(Logic)...

  • 汇图-iOS开发规范

    iOS开发规范 目录 格式与换行 命令 OC编码规范 注释要求 其他 序 此文档根据apple以及行业内比较知名的...

  • 20170317 Guidelines & AppSto

    Guidelines iOS开发规范整理 Objective-C编码规范:26个方面解决iOS开发问题 iOS开发...

  • 3个经常被忽略的iOS编码规范

    对于编程开发来说,编码规范是不可或缺的一个环节。在iOS开发领域,苹果也有官方的编码规范文档:《Coding Gu...

网友评论

    本文标题:iOS开发规范文档

    本文链接:https://www.haomeiwen.com/subject/cenqhftx.html