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

语句
条件语句

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

复制代码 代码如下:

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

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

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

可读性:可读性并不好。

时间: 2024-09-16 22:41:29

Objective-C编程中语句和变量的一些编写规范建议_IOS的相关文章

浅谈C语言编程中程序的一些基本的编写优化技巧_C 语言

大概所有学习C语言的初学者,都被前辈说过,C语言是世界上接近最速的编程语言,当然这并不是吹牛,也并不是贬低其他语言,诚然非C语言能写出高速度的代码,但是C语言更容易写出高速的程序(高速不代表高效),然而再好的工具,在外行人手中也只能是黯淡没落. 对于现代编译器,现代CPU而言,我们要尽量迎合CPU的设计(比如架构和处理指令的方式等),虽然编译器是为程序员服务,并且在尽它最大的能力来优化程序员写出的代码,但是毕竟它还没有脱离电子的范畴,如果我们的代码不能让编译器理解,编译器无法帮我们优化代码,那么

Shell编程中的特殊变量之进程状态变量介绍_linux shell

进程状态变量 1.$$获取当前shell的进程号(PID) 2.$!执行上一个指令的PID 3.$?获取执行上一个命令的返回值(0为成功,非零为失败,这个很常用) 4.$_在此之前执行的命令或脚本的最后一个参数 复制代码 代码如下: cat> test$.sh echo'$$='$$ echo'$!='$! echo'$?='$? echo'$@='$@ echo'$_='$_ #输出如下 sh test\$.sh 1 2 3 $$=2556 $!= $?=0 $@=1 2 3 $*和$@的区别

Shell编程中的特殊变量之位置变量介绍_linux shell

1.$0 获得当前脚本的文件名,包括路径. 复制代码 代码如下: #写一个测试脚本 vim test.sh #内容如下 dirname$0 basename$0 #执行一下 bash$(pwd)/test.sh #输出如下 /home/jane test.sh 2.$n 获取当前执行脚本的第n个参数,n=1..9,$0,为当前脚本名.如果n大于9,使用${10} 复制代码 代码如下: echo'echo '$(seq-s " $"1 5|sed's/1/$1/') > test_

C++编程中变量的声明和定义以及预处理命令解析_C 语言

关于C++变量的声明和定义 我们已经知道,一个函数一般由两部分组成:声明部分和执行语句. 声明部分的作用是对有关的标识符(如变量?函数?结构体?共用体等)的属性进行说明.对于函数,声明和定义的区别是明显的,前边已说明,函数的声明是函数的原型,而函数的定义是函数功能的确立.对函数的声明是可以放在声明部分中的,而函数的定义显然不在函数的声明部分范围内,它是一个文件中的独立模块. 对变量而言,声明与定义的关系稍微复杂一些.在声明部分出现的变量有两种情况:一种是需要建立存储空间的(如int a;):另一

关于ASP.NET编程中的嵌套If语句

本文将为大家简单介绍一下有关ASP.NET编程中的嵌套If语句的格式及用法,希望对大家有所帮助.下面就具体来看一下. 嵌套If语句 其格式如下: 以下是引用片段: If条件式1Then If条件式2Then 语句块1 Else 语句块1-2 EndIf 其他语句 Else 语句块2 EndIf 所谓的嵌套if语句,就是在If条件式中的语句块也是一组if条件式,其语句块又为一组if条件式,如此重复下去直到条件设置完毕. 一般而言,最复杂的条件式为嵌套条件式语句,以上所提到的所有条件式语句格式都可以

stm32-STM32的编程中,需要用Xdata,idata来定义变量吗?

问题描述 STM32的编程中,需要用Xdata,idata来定义变量吗? 用51内核时,如果遇到定义变量过多的时候,特别是数组比较多的时候,可以用xdata,idata来定义变量,但是不知道用STM32的时候,能用吗? 解决方案 按理说是支持的,我没有试过

shell 编程 语句-shell编程中的语句问题,求解答

问题描述 shell编程中的语句问题,求解答 #!/bin/bash use=cat cat_greet() { echo "hello cat" } if [ $use=cat ] then cat_greet fi no_exit=1 [[ $no_exit -eq 1 ]]&& exit(){true;} exit 这个程序输出结果为 hello cat 我想问的是 [[ $no_exit -eq 1 ]]&& exit() {true;} 这一句

脚本-shell编程中随机产生数组里一个变量的代码怎么写?

问题描述 shell编程中随机产生数组里一个变量的代码怎么写? 想写一个与随机抽取有关的脚本,从定义在数组里面的变量抽取,,初学shell编程很多细节不太会,朋友教教我 解决方案 function random() { min=$1; max=$2-$1; num=$(date +%s+%N); echo(num%max+min); } 假设数组长n,先使用random 0 n获得一个随机数a,然后数组[a]就是随机抽的变量 解决方案二: 可以给我讲解下不?不太看得懂,基础太差了

mysql-insert into values中select语句与变量怎样组合赋给values???

问题描述 insert into values中select语句与变量怎样组合赋给values??? string test;..... insert into table(abc) values ('1','2',(select name from tab3 where age =1) + test);意思就是values里,第三个字段的值是select查询结果 与 变量test的组合.. 我按照上面写,无法入库... 解决方案 已经解决了.多谢大家.使用concat才成功:方法 insert