iOS编码规范

一、编写规范的代码有什么好处?

   编写规范的代码,对于提升其可读性与可维护性大有裨益,看到规范的代码,不至于让自己的心情变坏,可以大大的提升工作效率。

二、怎样编写规范的代码?

(1)使用字面量语法,这样代码更加易懂,eg:

字面量语法

(2)换行和空格让代码变得整齐

使用换行和空格与否(上下对比)

一个典型的代表是SDAutoLayout的框架,链式的语法稍加换行使代码更加直观:

SDAutoLayout链式语言

(3)使用枚举表示状态

        先看一下UIButton所使用到的枚举

UIControlState枚举

枚举的每个值都是以UIControlState作为前缀的,这样能更好的根据代码提示找到所要的状态。

(4)使用分类简化你的代码

      我们通常将业务请求放在一个类里,方便维护,然而随着请求越来越多,那么这个类的代码也会越来越多,这个时候我们可以根据不同业务去设置不同的分类去将代码区分开来,不仅方便维护,也让代码更加直观。

类按业务进行分类

(5)实现description方法

控制台po model

在我创建的类中,没有实现description和debugDescription这两个方法,这个时候,log和po出来的仅仅是一个内存地址,对我们来说,没有办法查看model里面的字段,因此建议实现这两个方法。举个例子,如果我们想查看请求的model里面的字段,那么可以在BaseModel这个类的实现文件上面加上

description和debugDescription方法的实现

这个时候再po和log,model里面的字段就清楚了

po和log出model里面的字段

(6)使用多个target来区分正式环境、开发环境或马甲包

      可以用三个target,分别对应正式包、开发包以及马甲包,来维护三种不同的环境下的project,这样共用了一份代码,也可以根据需求对不同环境进行设置

不同的targets

在buildSetting设置对应的宏来区分不同的环境

在buildSettings里面设置宏

通过设置这个宏我们可以区分不同的环境,例如在设置项目请求的域名时可以

设置不同环境下的域名

(7)尝试解耦mvc模式

mvc是我们比较常用的设计模式,随着业务逻辑的不断累计,你可能会不断的在controller添加很多逻辑,这个是mvc的弊病,相信大家很清楚。

解耦在我的理解下,是用更多的文件,去分散一大堆的逻辑,举个例子:比如说,一个订单列表的controller里面已经非常赘余了,我们可以尝试把tableView或者collectionView相关的逻辑抽取出来,类似这样

订单列表相关的类

另外如果有更复杂的场景,例如订单的列表要显示出分类:未完成订单、已完成订单、已评价订单,让它们可以左右滑动,并且三个订单内部的逻辑差异比较大,这个将会导致你的controller里的代码量非常的多,这时你可以考虑使用三个controller将对应的逻辑分出来。

订单分类


附:

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 220,492评论 6 513
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 94,048评论 3 396
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 166,927评论 0 358
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 59,293评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,309评论 6 397
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 52,024评论 1 308
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,638评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,546评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 46,073评论 1 319
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,188评论 3 340
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,321评论 1 352
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,998评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,678评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,186评论 0 23
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,303评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,663评论 3 375
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,330评论 2 358

推荐阅读更多精彩内容

  • 命名 Bundle id命名: 规则:采用反域名命名规则,全部使用小写字母。一级包名为com,二级包名根据应用进行...
    Tippi阅读 1,659评论 0 2
  • 面试被问到公司编码规范问题,感觉有很多东西,但是不知道该怎么说出来,今天突然找到 李明杰 老师的一份编码规范。重新...
    Dombo_Y阅读 969评论 1 2
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,680评论 18 139
  • 注释规范 文件头注释 文件头注释采用如下格式,该注释由xcode自动生成。如果你对其他人的原始代码作出重大的修改,...
    yangzming阅读 729评论 0 1
  • Object-C 开发代码规范概要Object-C是一门面向对象的动态编程语言,主要用于编写IOS和MAC应用程序...
    克鲁德李阅读 536评论 0 1