欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  移动技术

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

程序员文章站 2023-12-06 10:06:28
语句 条件语句 条件语句体应该总被大括号包围。只有一行代码最好也加上,否则会带来安全隐患。 复制代码 代码如下: // 推荐 if (!error) { &nb...

语句
条件语句

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

复制代码 代码如下:

// 推荐
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];

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

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

可读性:可读性并不好。