2016-04-12 13:28:32 559浏览
在开发过程中,我们不仅要去看别人的代码,也要让别人看我们的代码。那么,有一个良好的编码习惯将会非常重要。下面一起来看一下关于使用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、宏定义全部字母大写。
13、函数长度不要超过50行,小函数比大函数可读性更强。函数的参数不宜过多,零元函数最好,一元函数也不错,高于三元的函数虚重构。
14、合理范围内使用链式编程:NSString *myName = [[NSString alloc] init];但是嵌套不宜超过3层,超过3层需进行重构。
15、函数调用时所有参数在同一行。如果参数过多,则可以每行一个参数,每个参数以冒号对齐。
16、 对传入参数的保护或者说是否为空的判断,尽量不要使用if(!obj),而使用NSAssert断言来处理。NSAssert是系统定义的宏。NSAssert(myName!= nil, @"myName参数为空"),如果条件判断为真,则程序继续执行;如果判断条件为假,则抛出异常,异常内容为后面定义的字符串;
17、方法参数名前一般使用"an","the","new"来进行修饰。如:-(void)setPersonInfo:(NSString*)theID theName:(NSString*)theName theAge:(NSInteger*)theAge
18、if-else超过四层的时候,就要考虑重构,多层的if-else结构很难维护。
19、当需要一定条件才执行某项操作时,最左边的应该是最重要的代码,不要将最重要的代码内嵌到if中。
如良好的风格是:- (void) someMethod{if(![someOther boolValue]) { return; }//最重要的代码写在这里;}
反面教材:-(void) someMethod{if([someOther boolValue]) { //重要代码;} }
20、所有的逻辑块都使用{}花括号包围,就算只是一行代码。
21、明确指定构造函数,并有适当的注释。
22、 不要在init方法中把变量或者说属性初始化为0或者nil,因为没有必要。
23、UIView的子类初始化的时候,不要进行任何的布局操作。布局操作应该在layoutSubviews里面做;需要重新布局的时候调用setNeedsLayout,而不要直接调用layoutSubviews。
24、保持公共API简单,也就是保持.h文件简单。放在.h中声明的函数都是会被公开的,如果根本就没必要对其他类公开,再不要在.h中声明。OC中的方法都是公有方法,没有私有方法一说。
25、一个文件只实现一个类。同一个文件中不要有多个类。
26、Protocol单独用一个文件来创建,尽量不要与相关类混在一个文件中。
27、在类定义中使用到自己定义类的时候,尽量不要在头文件中引入自己定义类的头文件,使用@class替代。而在实现文件中引入头文件。
28、布局时尽量使用相对布局,比如使用子View在父View中的相对位置。
29、代码折叠,这个可能是关于开发效率的,我也写在编码规范中,因为这个很有用。Xcode7默认没有开启代码折叠,如果你的方法体行数很长,看起来会很不方便,此时你就可以把方法“收起来”,一个类中的结构就会很清晰。开启方法如下:Xcode菜单-->Preferences-->Text Editing-->勾选Code folding ribbon。
希望以上对你将要学习iOS开发或即将从事iOS开发的你有所帮助!扣丁学堂作为北京千锋互联科技有限公司旗下的在线教育平台,通过线上线下相结合的形式,全方位的服务学员,从iOS开发入门基础到iOS UI设计再到iOS高级专题,最后是iOS项目实战。一套iOS从入门到到精通的免费iOS开发教程。