iOS编码规范整理(供参考)
每个公司甚至每个程序员都有自己的一套编码习惯,个体不同,风格自然是迥异的,为了项目的代码质量,团队往往会制定自己的编码规范。这是我们整理的编码规范,发表出来供大家参考哟。
iOS 编码规范
时间:2017-05-10 版本:1.0
前言:规范的编码可以避免很多问题,提高项目的稳定性,也增加了易读性和可维护性,所以,现在初步建立一套编码规范,之后再逐步完善。
1、命名规范
原则:
1)可读性高;
2)防止命名冲突;
类的命名
命名规范:
类名首字母大写,遵循OC语言的命名规范。类名要有实际的意义,如果类名太长,可
以省略一些不影响实际意义的单词,稍作简写。例如:
HomePageItemViewController ——> HomePageItemController
省略中间的view,大家依然知道它是一个VC,并不影响实际意义和可读性。
命名规则:
文件夹名字——类名——所属MVC类型结尾
例如:
HomeDetailViewController,————控制器
HomeDetailCell,————————-视图显示器
HomeDetailModel————————数据模型
变量命名
变量名称要有实际意义;
变量命名遵循OC的驼峰式命名规范;
如果是一个View,要以实际类型结尾;
变量名保持全英文结构,不要出现数字。
例如:cancelButton,titleLabel
常量命名
常量命名以m开头;
遵循驼峰命名规范;
例如:#define mScreenWidth ([UIScreen mainScreen].bounds.size.width)
方法名命名
小写字母开头;
有实际意义;
方法名前面一定要有注释;
公有方法最好以类名开头。
例如:
/**
- 保存图片到相册
- @param image 图片
- @param success 成功回调
- @param failure 失败回调
/
/ + (void)saveImageToAppAlbum:(UIImage)image success:(void (^)())success failure:(void (^)(NSError *error))failure;
2、资源文件
图片资源
资源文件存储按照功能分类,按照现有项目举例,项目中有“首页”,“订阅”,“发现”,“我”四个模块,图片资源就按照如下图大致分类:
图片资源的命名要遵循“文件夹名字”—“子文件名字”—“图片名字”,如果图片名字很长的情况下,可以省略最外层文件夹名字,不过不建议省略。图片命名一定要是英文,禁止出现中文命名。
音频,json,plist等其他资源文件
其他资源放在Supporting Files文件夹下,资源文件注意命名。
3、项目结构
现在项目的整体结构还是可以的,只是业务文件夹有些乱,没怎么整理。
项目结构上还是遵循MVC结构,按照功能分,一个模块一个文件夹,再加上三方库(如果使用pods,这个文件夹基本可以省略),Common文件夹
Bussiness文件夹——业务
home——首页
Common——公共
类中方法顺序(这个协商决定就好)
从上到下依次是:
重写父类的方法——> get/set——> 点击方法 ——> 自定义方法 ——> 代理方法
低调大师中文资讯倾力打造互联网数据资讯、行业资源、电子商务、移动互联网、网络营销平台。
持续更新报道IT业界、互联网、市场资讯、驱动更新,是最及时权威的产业资讯及硬件资讯报道平台。
转载内容版权归作者及来源网站所有,本站原创内容转载请注明来源。
- 上一篇
2017年你绝对想尝试的25个新安卓库(持续更新中...)
这是一份2017年1,2月份发布的25个最佳安卓库的列表,你应该会喜欢,虽然是按顺序排列的,但排名不分先后。让我们开始吧! 1.Lottie 这是一个能解析Adobe After Effects动画导出的JSON文件并把它们渲染成本地动画的库。在Google Play Store上有一个示例app。 github上超过7500颗星,应该不会错! 1487212976296618.gif 2.Toasty 一个创建自定义Toast的库。正如作者所说,这个库是:The usual Toast, but with steroids. 1487213029639021.png 3.StyleableToast 这是另外一个创建自定义Toast的库。 多个自定义选项让你的app和用户体验与众不同!用代码或者styles.xml去定义你的Toast样式。 1487213085134461.png 1487213120578175.gif 4.Store Store是一个异步加载和缓存库。文档描述: Store是一个简化数据的请求,解析,保存,以及数据重试的类。一个Store类似于 仓库模式 ,不过...
- 下一篇
iOS NSNotification的使用
如果在一个类中想要执行另一个类中的方法可以使用通知 1.创建一个通知对象:使用notificationWithName:object: 或者 notificationWithName:object:userInfo: NSNotification* notification = [NSNotification notificationWithName:kImageNotificationLoadFailed(connection.imageURL) object:self userInfo:[NSDictionary dictionaryWithObjectsAndKeys:error,@"error",connection.imageURL,@"imageURL",nil]]; 这 里需要注意的是,创建自己的通知并不是必须的。而是在创建自己的通知之前,采用NSNotificationCenter类的方 法postNotificationName:object: 和 postNotificationName:objec...
相关文章
文章评论
共有0条评论来说两句吧...
文章二维码
点击排行
推荐阅读
最新文章
- Eclipse初始化配置,告别卡顿、闪退、编译时间过长
- SpringBoot2整合MyBatis,连接MySql数据库做增删改查操作
- SpringBoot2整合Thymeleaf,官方推荐html解决方案
- SpringBoot2整合Redis,开启缓存,提高访问速度
- CentOS8编译安装MySQL8.0.19
- Docker使用Oracle官方镜像安装(12C,18C,19C)
- CentOS7,8上快速安装Gitea,搭建Git服务器
- Docker安装Oracle12C,快速搭建Oracle学习环境
- Springboot2将连接池hikari替换为druid,体验最强大的数据库连接池
- Windows10,CentOS7,CentOS8安装Nodejs环境