ios开发代码规范

原文链接:http://www.cocoachina.com/ios/20160324/15727.html

今天看了一篇关于代码规范的文章,感觉自己写代码还是比较注重规范的,不谈维护性,至少看上去代码很整洁,很规范。于是乎,写一篇文章来记录下让更多的开发可以学习下;规范其实是没有一个标准的,有些东西你遵守了他就是规范,不遵守就不是规范,但是你遵守了却能让代码规范起来。

摘录了一些比较常见的规范,括号里写了自己的一些看法。

1、 在每个方法的定义前留白一行,也就是在方法和方法之间留空一行。(很多人不空行,导致代码看起来一大坨,很不舒服,阅读性很差)

2、 功能相近的方法要放在一起,并推荐使用#pragma mark - ***来导航代码,切分代码块。这样可以方便函数的查找。并且可以使用快捷键control+6 来快速查找方法的位置。(这个还是很有必要的,分门别类,找起来很方便,不至于跨度很大)

3、 二元运算符和参数之间要有一个空格,如赋值号=左右各留一个空格。(这个虽然很小的点,但是却能让代码更美观,不至于代码很拥挤)

self.myString = @"235423rew523452345";

4、 尽量减少在代码中直接使用数字常量,而使用宏定义等方式。如:MAX_NUMBER_PHONE替代8等等。这样我们搜索也比较方便。(建议直接在工程中开一个单独的文件去存储哪些需要定义很多公用常量的情况,在大型企业级项目中显得尤为重要)

5、 宏定义全部字母大写。(很多新手容易会和常量的定义混淆,甚至以k开头大小写混合)

6、对传入参数的保护或者说是否为空的判断,尽量不要使用if(!obj),而使用NSAssert断言来处理。NSAssert是系统定义的宏。

 NSAssert(myName != nil, @"myName参数为空");

如果条件判断为真,则程序继续执行。

如果判断条件为假,则抛出异常,异常内容为后面定义的字符串。

7、if-else超过四层的时候,就要考虑重构,多层的if-else结构很难维护。(事实上在开发时很多人都会if else写一大坨,甚至还有很多魔法数字,让人看不懂)

8、当需要一定条件才执行某项操作时,最左边的应该是最重要的代码,不要将最重要的代码内嵌到if中。如良好的风格是:

- (void) someMethod {
 if(![someOther boolValue]) {
 return;
}
//最重要的代码写在这里;
}

反面教材:

- (void) someMethod {
  if([someOther boolValue]) {
      //重要代码;
  }
}

9、 UIView的子类初始化的时候,不要进行任何的布局操作。布局操作应该在layoutSubviews里面做;需要重新布局的时候调用setNeedsLayout,而不要直接调用layoutSubviews。(一般代码创建的时候这样做)

10、保持公共API简单,也就是保持.h文件简单。放在.h中声明的函数都是会被公开的,如果根本就没必要对其他类公开,不要在.h中声明。OC中的方法都是公有方法,没有私有方法一说。

11、 推荐方法的第一个花括号直接跟在方法体后,而不是另起一行,这样可以减少代码行。(这个看个人习惯,我比较推荐这种写法,而且苹果默认生成的方法也是这样)

12、 推荐方法体中的第一行留空,最后一行不留空,这样一个方法就会比较清晰。如图:


1458286863989143.png

但是如果该花括号里面又是一个if,for之类的带花括号的语句块,那么上述的第一行可以不留空。

同样,如果花括号内第一行是注释的话,第一行也可以不留空。注释也起到了分隔代码的作用,看起来比较清晰。

再者,如果花括号内只有一行代码,第一行可以不留空。

13、 由于提到编程经验,就不得不提到版本控制。务必去学会SVN或者Git,就算你是独立开发,也要学会控制自己的代码,当然,你要经常备份你的代码。(这个对代码的管理比较方便)

上面都是我觉得一些常见的规范,大家觉得是规范就可以去遵守。

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

推荐阅读更多精彩内容

  • 此文整理是为了方便一些朋友规范代码适用于新人(ps:如果你已经很规范的执行了那么可以跳过此内容)这样以来如果有...
    无沣阅读 367评论 0 1
  • 1. 关于命名 1.1 统一要求 含义清楚,尽量做到不需要注释也能了解其作用,若做不到,就加注释 使用全称,不适用...
    wei_j阅读 413评论 0 2
  • 一、代码规范 1. 命名规则 1)类名首字母大写,方法首字母小写,方法中的参数首字母小写,同时尽量让方法的命名...
    罗小耳阅读 676评论 0 7
  • 1. 关于命名 1.统一要求 含义清楚,尽量做到不需要注释也能了解其作用,若做不到,就加注释;使用全称,不使用缩写...
    ChinaGoodStaff阅读 266评论 0 2
  • 环境 Mac OS X Yosemite Sublime Text 3 MacTeX-2014 Skim 配置 参...
    墨水阅读 4,070评论 1 4