罗列使用Objective-C来开发iOS的编码建议

罗列使用Objective-C来开发iOS的编码建议

蓝鸥上海中心2016-03-28 14:10:01方法 代码 可以 阅读(224) 评论(0)

声明:本文由入驻搜狐公众平台的作者撰写,除搜狐官方账号外,观点仅代表作者本人,不代表搜狐立场。举报

在开发过程中,我们不仅要去看别人的代码,也要让别人看我们的代码。那么,有一个良好的编码习惯将会非常重要。下面将会罗列使用Objective-C来开发iOS的编码建议。

1. 任意函数长度不得超过50行。(其实很容易就超过50行,这就要考虑代码抽取了。

2. 任意行代码不能超过80字符。(其实也很容易超过80字符,可以考虑多行显示,比如有多个参数时,可以每个参数放一行。)可以在Xcode中设置超过80个字符的提醒,选中“Page guide at column”.设置完之后就会在代码80个字符处有一条竖线。

3. 在每个方法的定义前留白一行,也就是在方法和方法之间留空一行。

4. 功能相近的方法要放在一起,并推荐使用#pragma mark - ***来导航代码,切分

代码块。这样可以方便函数的查找。并且可以使用快捷键control+6 来快速查找方法的位置。

5. 二元运算符和参数之间要有一个空格,如赋值号=左右各留一个空格。

self.myString = @"235423rew523452345";

6. 一元运算符和参数之间不放置空格,比如!非运算符,&按位与,|按位或。

BOOL isOpen = true;BOOL isClose = !isOpen;

7. 强制类型转换和参数之间不放置空格。

NSString*str3 = (NSString*)self.myString;

8. 长的变量值应该拆分为多行。尤其体现在使用数组或者字典。以下也分别是快速声明数组@[]和字典@{}的方法。

NSArray *array = @[@"111",@"2222222222",@"3333333",@"wwwwwwwwwwww"];

NSDictionary *dict = @{@"name":@"jack",@"age":@"20",@"gender":@"female",@"isMarried":@"false"};

9. 尽量使用有意义的名字命名,拒绝使用i,j等无意义字符命名。类的命名首字母大写,其他变量的命名首字符小写,并使用驼峰式分割单词。

10. 尽量减少在代码中直接使用数字常量,而使用宏定义等方式。如:MAX_NUMBER_PHONE替代8等等。这样我们搜索也比较方便。

11. 尽量减少代码中的重复计算,比如代码中多处要使用屏幕宽度,然后计算:[[UIScreenmainScreen] bounds].size.width ,很多次,闲得很繁琐,代码也冗长。不如直接宏定义:

#defineSCREEN_WIDTH([[UIScreen mainScreen]bounds].size.width)

12. 合理使用约定俗成的缩略词:

alloc:分配;

alt:轮流,交替;

app:应用程序;

calc:计算;

dealloc:销毁、析构;

func:函数、方法;

horiz:水平的;

info:信息;

init:初始化;

max:最大的;

min:最小的;

msg:消息;

nib:Interface Builder;

rect:矩形;

temp:暂时的;

vert:垂直的;

13. 宏定义全部字母大写。

14. 函数长度不要超过50行,小函数比大函数可读性更强。函数的参数不宜过多,零元函数最好,一元函数也不错,高于三元的函数虚重构。

15. 合理范围内使用链式编程:

NSString *myName = [[NSString alloc] init];

但是嵌套不宜超过3层,超过3层需进行重构。

16. 函数调用时所有参数在同一行。如果参数过多,则可以每行一个参数,每个参数以冒号对齐。

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

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

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

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

18. 方法参数名前一般使用"an","the","new"来进行修饰。如:

-(void)setPersonInfo:(NSString*)theID theName:(NSString*)theName theAge:(NSInteger*)theAge

19. if-else超过四层的时候,就要考虑重构,多层的if-else结构很难维护。

20. 当需要一定条件才执行某项操作时,最左边的应该是最重要的代码,不要将最重要的代码内嵌到if中。

如良好的风格是:

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

反面教材:

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

21. 所有的逻辑块都使用{}花括号包围,就算只是一行代码。

22. 明确指定构造函数,并有适当的注释。

23. 不要在init方法中把变量或者说属性初始化为0或者nil,因为没有必要。

24. UIView的子类初始化的时候,不要进行任何的布局操作。布局操作应该在layoutSubviews里面做;需要重新布局的时候调用setNeedsLayout,而不要直接调用layoutSubviews。

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

26. 一个文件只实现一个类。同一个文件中不要有多个类。

27. Protocol单独用一个文件来创建,尽量不要与相关类混在一个文件中。

28. 在类定义中使用到自己定义类的时候,尽量不要在头文件中引入自己定义类的头文件,使用@class替代。而在实现文件中引入头文件。

29. 布局时尽量使用相对布局,比如使用子View在父View中的相对位置。

30. 代码折叠,这个可能是关于开发效率的,我也写在编码规范中,因为这个很有用。Xcode7默认没有开启代码折叠,如果你的方法体行数很长,看起来会很不方便,此时你就可以把方法“收起来”,一个类中的结构就会很清晰。开启方法如下:

Xcode菜单-->Preferences-->Text Editing-->勾选Code folding ribbon.如图:

31. 推荐方法的第一个花括号直接跟在方法体后,而不是另起一行,这样可以减少代码行。

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

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

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

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

33. block中第一行也要留空,同方法体中的第一行留空,使代码清晰。

34. 代表类方法和实例方法的"+"加号,"-"减号后需要一个空格。这是一个非常小的细节,系统默认的方法都是这样的,我们自己声明或者实现一个方法的时候也需要这样:

35. 这一条有点像编程经验了,就是为解决某个问题估算时间。比如要开发某个功能、调试某个bug、给自己一个时间限制,如果在这期间不能解决问题,那么就去寻求帮助。这既是给自己一个压力,也为了不浪费时间。虽然,这一条其实很难做到,我往往由于不甘心而无限拖延时间去解决问题。

36. 由于提到编程经验,就不得不提到版本控制。务必去学会SVN或者Git,就算你是独立开发,也要学会控制自己的代码,当然,你要经常备份你的代码。

希望以上对你将要学习iOS开发或即将从事iOS开发的你有所帮助!蓝鸥iOS开发培训有着国内首家完整的移动iOS开发课程体系,高度专注iOS前沿技术。蓝鸥iOS培训开发项目全部来自于真实的企业项目,单独项目代码量超过5 万行。为了让学员尽快的进入到企业开发的项目中,蓝鸥使用自主开发的产品和为客户定制的企业产品为案例,大批蓝鸥iOS培训开发学员都从中收益。

我们是一群热爱IT的年轻人,如果你也爱IT、爱ios开发,欢迎前来蓝鸥上海iOS培训中心参观学习,让我们共同为梦想发声。

LOGO

+订阅

12天免费试听,零学费入学!

iOS课程,平均就业薪资8500+的课程!

上海iOS、html5报名入口

上海html5、 iOS火热报名中!

阅读(224) 举报

31喜欢 1没劲 分享到

热门关注

搜生活

搜生活+关注

搜狐公众平台官方账号

MAGIC杨梦晶

MAGIC杨梦晶+关注

生活时尚&搭配博主 /生活时尚自媒体 /时尚类书籍作者

搜狐教育

搜狐教育+关注

搜狐网教育频道官方账号

星吧GEO

星吧GEO+关注

全球最大华文占星网站-专业研究星座命理及测算服务机构

我来说两句(0人参与)

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

推荐阅读更多精彩内容