Objective-C编程中语句和变量的一些编写规范建议

121 阅读 0 评论 80 点赞

我是靠谱客的博主真实眼神，最近开发中收集的这篇文章主要介绍Objective-C编程中语句和变量的一些编写规范建议，觉得挺不错的，现在分享给大家，希望可以做个参考。

概述

语句
条件语句

条件语句体应该总被大括号包围。只有一行代码最好也加上，否则会带来安全隐患。

复制代码代码如下:

// 推荐
if (!error) {
return success;
}

// 不推荐
if (!error)
return success;

if (!error) return success;

尤达表达式(Yoda)

不要使用尤达表达式。（名字起源于星球大战中尤达大师的讲话方式，总是用倒装的语序）

复制代码代码如下:

// 推荐
if ([myValue isEqual:@42]) { ...

// 不推荐
if ([@42 isEqual:myValue]) { ...

nil和BOOL的检查

一些人喜欢用这样的方式来检查nil：

复制代码代码如下:

if (nil == myValue) { ...

这样做可以避开少些一个"=“的错误，因为一旦少写一个”=“，那么nil是不能被赋值的，编译器会报错。

但是前面提到，最好不要使用尤达表达式。所以更好的解决方法是用”!”来完成nil和BOOL的检查。

复制代码代码如下:

// 推荐
if (someObject) { ...
if (![someObject boolValue]) { ...
if (!someObject) { ...

// 不推荐
if (someObject == YES) { ... // Wrong
if (myRawValue == YES) { ... // Never do this.
if ([someObject boolValue] == NO) { ...

不要嵌套多个if语句

不要嵌套多个if语句，而是使用多个return来避免增加复杂度，并提高代码可读性。

也就是说，在一个方法中，重要的部分尽量不要放在if语句中，而是将”其它情况”放在if中。

复制代码代码如下:

// 推荐
- (void)someMethod {
if (![someOther boolValue]) {
return;
}

//Do something important
}

// 不推荐
- (void)someMethod {
if ([someOther boolValue]) {
//Do something important
}
}

复杂的表达式

当一个判断条件很复杂时，应该将它们提取出来赋值给一个BOOL变量。

复制代码代码如下:

BOOL nameContainsSwift = [sessionName containsString:@"Swift"];
BOOL isCurrentYear = [sessionDateCompontents year] == 2014;
BOOL isSwiftSession = nameContainsSwift && isCurrentYear;

if (isSwiftSession) {
// Do something very cool
}

三元运算符

三元运算符要保证可读性。

复制代码代码如下:

// 推荐
result = a > b ? x : y;

// 不推荐
result = a > b ? x = c > d ? c : d : y;

当三元运算符的第二个参数（if 分支）返回和条件语句中已经检查的对象一样的对象的时候，下面的表达方式更灵巧：

复制代码代码如下:

// 推荐
result = object ? : [self createObject];

// 不推荐
result = object ? object : [self createObject];

错误处理

有些方法通通过参数返回 error 的引用，使用这样的方法时应当检查方法的返回值，而非 error 的引用。

复制代码代码如下:

// 推荐

NSError *error = nil;

if (![self trySomethingWithError:&error]) {

    // Handle Error

}

switch语句中的case，如果只有一行代码可以不必加上大括号，但是多行需要加上。

复制代码代码如下:

switch (condition) {

    case 1:

        // ...

        break;

    case 2: {

        // ...

        // Multi-line example using braces

        break;

       }

    case 3:

        // ...

        break;

    default: 

        // ...

        break;

}

枚举类型

使用NS_ENUM()这个宏来定义枚举，它有更强大的的类型检查和代码补全。

复制代码代码如下:

typedef NS_ENUM(NSUInteger, ZOCMachineState) {

    ZOCMachineStateNone,

    ZOCMachineStateIdle,

    ZOCMachineStateRunning,

    ZOCMachineStatePaused

};

变量
尽量使用长的、描述性的方法和变量名。

复制代码代码如下:

// 推荐
UIButton *settingsButton;

// 不推荐
UIButton *setBut;

常量应该以驼峰法命名，并以相关类名作为前缀。

复制代码代码如下:

// 推荐
static const NSTimeInterval ZOCSignInViewControllerFadeOutAnimationDuration = 0.4;

// 不推荐
static const NSTimeInterval fadeOutTime = 0.4;

推荐使用常量来代替字符串字面值和数字。可以方便复用，快速修改。

常量应该用static声明为静态常量，而不要用#define，除非它明确作为宏来使用。

复制代码代码如下:

// 推荐
static NSString * const ZOCCacheControllerDidClearCacheNotification = @"ZOCCacheControllerDidClearCacheNotification";

static const CGFloat ZOCImageThumbnailHeight = 50.0f;

// 不推荐
#define CompanyName @"Apple Inc."
#define magicNumber 42

常量如果需要暴露给外部，那么要在头文件中以这样的形式：

复制代码代码如下:

extern NSString *const ZOCCacheControllerDidClearCacheNotification;

并在实现文件中为它赋值。

只有公有的常量才需要添加命名空间作为前缀。尽管实现文件中私有常量的命名可以遵循另外一种模式，你仍旧可以遵循这个规则。

方法名与方法类型（-/+符号）间应加上一个空格。

方法段间也应该以空格间隔。

参数前应该有一个描述性的关键词。

尽可能少用”and”这个词，它不应该用来阐明有多个参数。

复制代码代码如下:

// 推荐
- (void)setExampleText:(NSString *)text image:(UIImage *)image;
- (void)sendAction:(SEL)aSelector to:(id)anObject forAllCells:(BOOL)flag;
- (id)viewWithTag:(NSInteger)tag;
- (instancetype)initWithWidth:(CGFloat)width height:(CGFloat)height;

// 不推荐
- (void)setT:(NSString *)text i:(UIImage *)image;
- (void)sendAction:(SEL)aSelector :(id)anObject :(BOOL)flag;
- (id)taggedView:(NSInteger)tag;
- (instancetype)initWithWidth:(CGFloat)width andHeight:(CGFloat)height;
- (instancetype)initWith:(int)width and:(int)height; // Never do this.

使用字面值来创建不可变的NSString,NSDictionary,NSArray和NSNumber对象。

用这种方式，注意不要将nil放在NSArray和NSDictionary里，这样会导致崩溃。

复制代码代码如下:

NSArray *names = @[@"Brian", @"Matt", @"Chris", @"Alex", @"Steve", @"Paul"];

NSDictionary *productManagers = @{@"iPhone" : @"Kate", @"iPad" : @"Kamal", @"Mobile Web" : @"Bill"};

NSNumber *shouldUseLiterals = @YES;

NSNumber *buildingZIPCode = @10018;

不要这样：

复制代码代码如下:

NSArray *names = [NSArray arrayWithObjects:@"Brian", @"Matt", @"Chris", @"Alex", @"Steve", @"Paul", nil];

NSDictionary *productManagers = [NSDictionary dictionaryWithObjectsAndKeys: @"Kate", @"iPhone", @"Kamal", @"iPad", @"Bill", @"Mobile Web", nil];

NSNumber *shouldUseLiterals = [NSNumber numberWithBool:YES];

NSNumber *buildingZIPCode = [NSNumber numberWithInteger:10018];

避免这样的方式创建可变数组：

复制代码代码如下:

NSMutableArray *aMutableArray = [@[] mutableCopy];

这样的方式，在效率和可读性上都存在问题。

效率：一个不必要的不可变数组被创建后马上被废弃，并没有必要。

可读性：可读性并不好。