iOS开发之编码规范建议
白羽 2018-06-22 来源 :网络 阅读 1575 评论 0

摘要:本文将带你了解iOS开发之编码规范建议,希望本文对大家学IOS有所帮助。

 


下面将会罗列使用Objective-C来开发iOS的编码建议。

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

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

 iOS开发之编码规范建议

【3】在每个方法的定义前留白一行。

【4】功能相近的方法要放在一起,并推荐使用#pragma mark - ***来导航代码,切分代码块。这样可以方便函数的查找。并且可以使用快捷键control+6 来快速查找方法的位置。

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

[objc] view plain copy

1. self.myString = @"235423rew523452345";    

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

[objc] view plain copy

1. BOOL isOpen = true;    

2. BOOL isClose = !isOpen;    

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

[objc] view plain copy

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

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

[objc] view plain copy

1. NSArray *array = @[@"123",  

2.                    @"456",  

3.                    @"789",  

4.                    @"abc"  

5.                    ];  

6. NSDictionary *dic = @{@"first" : @1 ,  

7.                       @"second" : @2 ,  

8.                       @"third" : @3  

9.                       };  

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

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

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

[objc] view plain copy

1. #define SCREEN_WIDTH ([[UIScreen mainScreen] bounds].size.width)    

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

[objc] view plain copy

1. alloc:分配;   vert:垂直的;   temp:暂时的;   alt:轮流,交替;  

2. app:应用程序;   calc:计算;    dealloc:销毁  func:函数、方法;  

3. horiz:水平的;  info:信息;    init:初始化;   max:最大的;min:最小的;  

4. msg:消息; nib:Interface Builder;      rect:矩形;  

【13】宏定义全部字母大写。

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

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

[objc] view plain copy

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

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

【16】函数调用时所有参数在同一行。如果参数过多,则可以每行一个参数,每个参数以冒号对齐。
【17】对传入参数的保护或者说是否为空的判断,尽量不要使用if(!obj),而使用NSAssert断言来处理。NSAssert是系统定义的宏。

[objc] view plain copy

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

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

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

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

[objc] view plain copy

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

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

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

如良好的风格是:

[objc] view plain copy

1. - (void) someMethod {    

2. if(![someOther boolValue]) {    

3.    return;    

4.   }    

5. //最重要的代码写在这里;    

6. }    

反面教材:

[objc] view plain copy

1.    

2. - (void) someMethod {    

3. if([someOther boolValue]) {     

4.      //重要代码;    

5.   }    

6. }    

【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中的相对位置。



本文由职坐标整理并发布,希望对同学们有所帮助。了解更多详情请关注职坐标移动开发之IOS频道!


本文由 @白羽 发布于职坐标。未经许可,禁止转载。
喜欢 | 0 不喜欢 | 0
看完这篇文章有何感觉?已经有0人表态,0%的人喜欢 快给朋友分享吧~
评论(0)
后参与评论

您输入的评论内容中包含违禁敏感词

我知道了

助您圆梦职场 匹配合适岗位
验证码手机号,获得海同独家IT培训资料
选择就业方向:
人工智能物联网
大数据开发/分析
人工智能Python
Java全栈开发
WEB前端+H5

请输入正确的手机号码

请输入正确的验证码

获取验证码

您今天的短信下发次数太多了,明天再试试吧!

提交

我们会在第一时间安排职业规划师联系您!

您也可以联系我们的职业规划师咨询:

小职老师的微信号:z_zhizuobiao
小职老师的微信号:z_zhizuobiao

版权所有 职坐标-一站式AI+学习就业服务平台 沪ICP备13042190号-4
上海海同信息科技有限公司 Copyright ©2015 www.zhizuobiao.com,All Rights Reserved.
 沪公网安备 31011502005948号    

©2015 www.zhizuobiao.com All Rights Reserved