iOS代码规范

作者: AdamShi | 来源:发表于2022-07-10 23:42 被阅读0次

    根据苹果官方代码规范文档,及其他通用规范总结出的一套代码规范.选取了一些主要的代码规范,去掉了一些特别细节的规范
    好处: 如果组内遵守同一套规范,代码风格保持一致,提高工作效率,降低沟通成本,能快速读懂对方代码

    一.命名

    1.大驼峰命名法

    所有单词首字母大写,包括第一个单词
    适用范围:
    文件类: 工程名,组件名,文件夹名,文件名, 类名
    代码中: 枚举的声明,协议的声明

    2.小驼峰命名法

    第一个单词首字母消息,其余单词首字母大写
    适用范围:
    代码中: 日常代码

    3.前缀

    苹果文档中,前缀建议为2-3位的字母比较合适,所以SAS比较合适,SAAS就比较长了; 在命名Category、类、协议、常量和typedef结构时应使用前缀

    4.后缀

    具体用哪种后缀参考苹果
    a.末尾是功能描述,例如枚举.UITableViewStylePlain和UITableViewStyleGrouped等等
    b.末尾是固定描述,例如通知.末尾固定是Notification

    5.资源类

    图片命名应全小写,并用下划线_连接,如tabbar_home_normal

    二.宏定义,常量的使用

    1.宏定义

    苹果不推荐使用太多宏定义,宏定义是预编译,不会做语法检查,太多的宏定义会造成编译速度越来越慢.
    适用范围: 函数,方法等可以适量使用宏定义.(也可以使用内联函数代替宏定义,内联函数会有类型检查)

    2.常量

    静态常量,是编译时加载,有编译检查,且可以在控制台打印调试.实际使用时,一般用static+const声明静态的全局只读常量,,第一个字母一般是小写字母k, 例如
    static NSString * const kSASStaticString = @"kSASStaticString";
    适用范围: 整形,浮点型,字符串等

    三.类文件的代码顺序

    代码顺序尽量和类加载逻辑等保持一致.
    重要的,能快速了解这个类做了什么的逻辑放到上面,例如生命周期,申请接口数据,刷新UI等; 不太重要的,不经常改动的逻辑放到下面,例如懒加载等等

    1.生命周期(包括dealloc)

    2.请求接口

    3.刷新UI

    4.按钮事件,通知事件,等等

    5.代理方法

    6.set方法

    7.懒加载

    四.代码数

    尽量多封装,单个类的代码行数最好不超过1000行.特别复杂的类最好不超过1500行;
    单个方法函数的代码行数最好不超过100行

    五.工具

    1.代码块

    2.类模板

    参考文档
    苹果官方代码规范文档:Cocoa 编码指南
    iOS中关于宏定义与常量的使用
    如何正确使用const,static,extern
    宏定义与常量的使用
    iOS代码规范
    OC风格指南

    相关文章

      网友评论

        本文标题:iOS代码规范

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