在开发过程中,我们不仅要去看别人的代码,也要让别人看我们的代码。那么,有一个良好的编码习惯将会非常重要。下面将会罗列使用Objective-C来开发iOS的编码建议。
【1】任意函数长度不得超过50行。(其实很容易就超过50行,这就要考虑代码抽取了。)
【2】任意行代码不能超过80字符。(其实也很容易超过80字符,可以考虑多行显示,比如有多个参数时,可以每个参数放一行。)可以在Xcode中设置超过80个字符的提醒,选中“Page guide at column”.设置完之后就会在代码80个字符处有一条竖线。[Xcode菜单–>Preferences–>Text Editing–>勾选Page guide at column.]
【3】在每个方法的定义前留白一行,也就是在方法和方法之间留空一行。
【4】功能相近的方法要放在一起,并推荐使用#pragma mark – *来导航代码,切分代码块。这样可以方便函数的查找。并且可以使用快捷键control+6 来快速查找方法的位置。
1 2 3 4 5 6 7 8 9 10 11 12 13 |
#pragma mark - 生命周期 - (void)viewDidLoad { [super viewDidLoad]; // Do any additional setup after loading the view. } #pragma mark - 代理 MapView /** 当地图显示区域发生变化时触发 */ - (void)mapView:(MKMapView *)mapView regionDidChangeAnimated:(BOOL)animated{ [self showBussinessedInMapView]; } |
【5】二元运算符和参数之间要有一个空格,如赋值号=左右各留一个空格。
1 |
self.myString = @"235423rew523452345"; |
【6】一元运算符和参数之间不放置空格,比如!非运算符,&按位与,|按位或。
1 2 |
BOOL isOpen = true; BOOL isClose = !isOpen; |
【7】强制类型转换和参数之间不放置空格。
1 |
NSString *str3 = (NSString*)self.myString; |
【8】长的变量值应该拆分为多行。尤其体现在使用数组或者字典。以下也分别是快速声明数组@[]和字典@{}的方法。
1 2 3 4 5 6 7 8 9 |
NSArray *array = @[@"111", @"2222222222", @"3333333", @"wwwwwwwwwwww" ]; NSDictionary *dict = @{@"age":@"20", @"gender":@"female", @"isMarried":@"false" }; |
【9】尽量使用有意义的名字命名,拒绝使用i,j等无意义字符命名。类的命名首字母大写,其他变量的命名首字符小写,并使用驼峰式分割单词。
【10】尽量减少在代码中直接使用数字常量,而使用宏定义等方式。如:MAX_NUMBER_PHONE替代8等等。这样我们搜索也比较方便。
【11】尽量减少代码中的重复计算,比如代码中多处要使用屏幕宽度,然后计算:[[UIScreenmainScreen] bounds].size.width ,很多次,闲得很繁琐,代码也冗长。不如直接宏定义:
1 |
#define SCREEN_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】合理范围内使用链式编程:
1 |
NSString *myName = [[NSString alloc] init]; |
但是嵌套不宜超过3层,超过3层需进行重构。
【16】函数调用时所有参数在同一行。如果参数过多,则可以每行一个参数,每个参数以冒号对齐。
1 2 3 |
[[NSNotificationCenter defaultCenter] addObserver:activityIndicator selector:NSSelectorFromString(@"startActivity") name:SDWebImageDownloadStartNotification object:nil]; |
【17】对传入参数的保护或者说是否为空的判断,尽量不要使用if(!obj),而使用NSAssert断言来处理。NSAssert是系统定义的宏。
【3】在每个方法的定义前留白一行,也就是在方法和方法之间留空一行。
【4】功能相近的方法要放在一起,并推荐使用#pragma mark – *来导航代码,切分代码块。这样可以方便函数的查找。并且可以使用快捷键control+6 来快速查找方法的位置。
1 2 3 4 5 6 7 8 9 10 11 12 13 |
#pragma mark - 生命周期 - (void)viewDidLoad { [super viewDidLoad]; // Do any additional setup after loading the view. } #pragma mark - 代理 MapView /** 当地图显示区域发生变化时触发 */ - (void)mapView:(MKMapView *)mapView regionDidChangeAnimated:(BOOL)animated{ [self showBussinessedInMapView]; } |
【5】二元运算符和参数之间要有一个空格,如赋值号=左右各留一个空格。
1 |
self.myString = @"235423rew523452345"; |
【6】一元运算符和参数之间不放置空格,比如!非运算符,&按位与,|按位或。
1 2 |
BOOL isOpen = true; BOOL isClose = !isOpen; |
【7】强制类型转换和参数之间不放置空格。
1 |
NSString *str3 = (NSString*)self.myString; |
【8】长的变量值应该拆分为多行。尤其体现在使用数组或者字典。以下也分别是快速声明数组@[]和字典@{}的方法。
1 2 3 4 5 6 7 8 9 |
NSArray *array = @[@"111", @"2222222222", @"3333333", @"wwwwwwwwwwww" ]; NSDictionary *dict = @{@"age":@"20", @"gender":@"female", @"isMarried":@"false" }; |
【9】尽量使用有意义的名字命名,拒绝使用i,j等无意义字符命名。类的命名首字母大写,其他变量的命名首字符小写,并使用驼峰式分割单词。
【10】尽量减少在代码中直接使用数字常量,而使用宏定义等方式。如:MAX_NUMBER_PHONE替代8等等。这样我们搜索也比较方便。
【11】尽量减少代码中的重复计算,比如代码中多处要使用屏幕宽度,然后计算:[[UIScreenmainScreen] bounds].size.width ,很多次,闲得很繁琐,代码也冗长。不如直接宏定义:
1 |
#define SCREEN_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】合理范围内使用链式编程:
1 |
NSString *myName = [[NSString alloc] init]; |
但是嵌套不宜超过3层,超过3层需进行重构。
【16】函数调用时所有参数在同一行。如果参数过多,则可以每行一个参数,每个参数以冒号对齐。
1 2 3 |
[[NSNotificationCenter defaultCenter] addObserver:activityIndicator selector:NSSelectorFromString(@"startActivity") name:SDWebImageDownloadStartNotification object:nil]; |
【17】对传入参数的保护或者说是否为空的判断,尽量不要使用if(!obj),而使用NSAssert断言来处理。NSAssert是系统定义的宏。
1 2 |