读代码随笔


命名

  • 在定义各种viewcontroller是没有统一使用前缀,可以和第三方库形成命名重复,同事在错误时不利于定位。如YHMainViewController,YHLessionPerformenceView等等
  • 如在CtrlMain中,变量mNoWorkInfomWrkChartLblShow,mLesLblDataContMain根本不知道是什么。其实是UIView,可以写noWorkInfoView,至少知道是那一类,如果是UIButton,可以申明为UIButton *xxxButton,尾部带上类名。
  • 各种缩写,不知道什么意思。(缩写了而且没有注释),如主页CtrlMain,至少应该是MainViewController
  • 私有方法同样可以加前缀方便追踪,如p_doSomeThing,yh_doOtherThing.
  • 在网络访问时方法名如:getTextFieldValuegetTokenWithMobile,一般可以改为textFieldValue,tokenWithMobile,等等。而且get很少使用,即使是表示动作累方法时。
    *mLesLblDataContMain,这个必须单独拿出啦,简直就是奇葩,各种缩写les,lbl,cont,没有类,神仙也猜不到什么东东啊。居然是一个label对象,那个地方的lable呢自己估计都不知道。
    可以参考《代码命名规范》相关文章

Define

  • 大量的宏定义,宏定义也存在命名不规范。关键是现在不推荐宏定义来定义变量,而是通过关键字staticconst来定义变量。

NS_ENUM

  • 对于有限的选项可以使用enum来增强可读性,避免使用0,1等。如:
typedef NS_ENUM(NSInteger, UIBarButtonItemStyle) {
    UIBarButtonItemStylePlain,
    UIBarButtonItemStyleBordered,
    UIBarButtonItemStyleDone,
};

Switch

  • 使用switch语句时,case下尽量不要写整个方法的实现,应把单独写一个方法。这样一眼就可以看着每个分支的功能。如:
case UIBarButtonItemStylePlain:
    [self doSomeThing];
    break;
case UIBarButtonItemStyleBordered:
    [self doOtherThing];
    break;

备注:case UIBarButtonItemStylePlain:参考NS_ENUM。

代码注释

  • 论坛上很多人对于代码注释持不同态度,可能认为代码注释太多说明命名处理问题。但毕竟代码注释确实可以为以后维护提供了很大的方便,尤其是在命名方面不是特别好,设计很好的情况下建议加注释。也为以后生成文档提供了方便,如appledoc工具。

属性关键字copy,readonly

  • 如果不希望外边修改开放的属性,可以使用扩展。如果必须对外开放的属性尽量使用readonly关键字修饰属性,设置为只读,格外写类似addremove方法进行修改。
  • 如果是NSString类型尽可能使用copy关键字修饰,防止对象被修改导致联动。

UIViewController

controller扮演的角色是数据管理,数据调配。不相关的事情最好不要放到里边,最好封装提供接口。

  • 大量的view初始化代码都放到conroller中,导致controller代码臃肿。导致主要的逻辑被view模块给淹没,很不利用扩展维护。 可以对view进行封装,使用懒加载,在getter中统一初始化。这样只有主要逻辑(强业务)放到controller中。
  • CtrlMain中成绩展示写死在controller中,每次修改都要修改contrller中代码不利于扩展。比如增加减少科目等。
  • 网络访问也可以封装一个类似NetWork类,提供网络获取数据,只给controller提供一个借口访问获得数据,具体怎获得,使用的什么网络库,controller不应该知道。
  • controller臃肿,之前有博客分享controller中只应该有这几个分层
    #pragam LifeCycle#pragam Event Method#pragam Delegate#pragam Pravite Method#pragam Setter and Getter。原则就是能不放到controller中的就不放,全部模块化有利于维护和扩展。

代码小习惯

  • 苹果建议多使用类似CGRectGetWidth(CGRect),少使用[[UIScreen mainScreen] bounds].size.heigh简单复用,更可读,如:
WorkSubjectsView *wrkSubject = [[WorkSubjectsView alloc] initWithFrame:CGRectMake(Subject_DIV * [[UIScreen mainScreen] bounds].size.width + (i % 3) *(Subject_DIV + Subject_width) * [[UIScreen mainScreen] bounds].size.width,[self getViewBottom:seperateLine] +(Subject_Div_Vertical - Subject_Hight) *[[UIScreen mainScreen] bounds].size.height + (i / 3) * Subject_Div_Vertical *[[UIScreen mainScreen] bounds].size.height,Subject_width * [[UIScreen mainScreen] bounds].size.width, Subject_Hight * [[UIScreen mainScreen] bounds].size.height)];

可以把 [[UIScreen mainScreen] bounds].size.height单独拿出来

CGFloat height = CGRectGetHeight([UIScreen mainScreen].bounds);
CGFloat width  = CGRectGetWidth([UIScreen mainScreen].bounds);

使用heightwidth替换 [[UIScreen mainScreen] bounds].size.height,方法会简短很多,更易读。

可以参考文章:iOS应用架构谈 view层的组织和调用方案

关于代码设计

  • 主页包含了三个CtrlMain,分别是老师端,家长端,学生端,分别实现了loadView 而且主界面非常相似,简单的办法可以使用一个Util抽出重复代码,好一点的办法把相关view抽出使用组合方式实现CtrlMain,从而实现代码复用,即便view样式变化也不用再去修改CtrlMain代码。

自己也在学习中,可以参考《大话设计模式》、《iOS设计模式》书籍。

关于代码强迫症

  • 大量的警告,很多都是方法过期,以及常量转换问题,尽管对运行一般没有影响,但如我我们自己特意写的警告可能会被淹没,不好寻找。
  • 使用Analyze分析大量的内存泄露,以及logic error,以及dead store *

只要稍微花一点时间检查就可以避免警告,很多人说写代码最低的要求就是,零警告并且可以通过Analyze测试。当然我们还可以使用instruments进行更多的优化

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

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,813评论 25 707
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,633评论 18 139
  • 27、ViewController的didReceiveMemoryWarning是在什么时候调用的?默认的操作是...
    烟雨平生花飞舞阅读 566评论 0 1
  • 有趣的问题 你编写过的最酷的代码是什么?其中你最自豪的是什么? 在你使用过的开发工具中,最喜欢哪个? 你有什么业余...
    春木橙云阅读 203评论 0 0
  • 姓名:王方河 公司:宁波大发化纤有限公司 宁波盛和塾《六项精进》235期学员。 【日精进打卡第39天】 【知~学习...
    北辕南辙阅读 149评论 0 0