今天看了一篇关于代码规范的文章,感觉自己写代码还是比较注重规范的,不谈维护性,至少看上去代码很整洁,很规范。于是乎,写一篇文章来记录下让更多的开发可以学习下;规范其实是没有一个标准的,有些东西你遵守了他就是规范,不遵守就不是规范,但是你遵守了却能让代码规范起来。
摘录了一些比较常见的规范,括号里写了自己的一些看法。
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,就算你是独立开发,也要学会控制自己的代码,当然,你要经常备份你的代码。(这个对代码的管理比较方便)
网友评论