当前位置: 首页 > 编程笔记 >

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

郗鹏
2023-03-14
本文向大家介绍Objective-C编程中语句和变量的一些编写规范建议,包括了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];


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

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

可读性:可读性并不好。

 类似资料:
  • C++编程规范 C/C++编程规范 C/C++编程规范--北京软通动力信息技术有限公司 高质量C/C++编程规范指南 C语言编程规范--华为技术有限公司 Google C++ 编程规范 C++编程规范:101条规则、准则与最佳实践 PDF扫描版.pdf C++ 编程规范专栏

  • 这里我将描述文档编写规范格式,将从一下几个方面进行详细的介绍。 标题 文本 段落 数字 标点符号 文档体系 标题 定义文档中标题的使用规范。 层级 一级标题:文章的主标题 二级标题:文章的主干章节标题 三级标题:章节下的分支标题 四级标题:属三级标题内的分支标题 示例 # 一级标题 ## 二级标题 ### 三级标题 #### 四级别标题 原则 一级标题,全文仅能有一个一级标题,在本站中每篇文章的

  • Block 基础 Block 语法 Block 可以认为是一种匿名函数,使用如下语法声明一个 Block 类型: return_type (^block_name)(parameters) 例如: double (^multiplyTwoValues)(double, double); Block 字面值的写法如下: ^ (double firstValue, double secondValue

  • 本文向大家介绍Dojo Javascript 编程规范 规范自己的JavaScript书写,包括了Dojo Javascript 编程规范 规范自己的JavaScript书写的使用技巧和注意事项,需要的朋友参考一下 前言 良好的JavaScript书写习惯的优点不言而喻,今天彬Go向大家推荐Dojo Javascript 编程规范,相当不错的 Javascript 编程风格规范,建议大家可以借鉴一

  • Sass 的终极目标是解决 CSS 的缺陷。如我们所知,CSS 并不是一个完美的语言。CSS 虽然简单易学,却也能迅速制造严重的混淆,尤其是在工程浩大的项目中。

  • 编程规范是对编程的一种约定,主要作用是增强代码的可读性和可维护性,便于代码重用。 首先要求程序中的各个要素都遵守命名规则,然后在编码中严格按照编码格式编写代码。命名规则包括以下几点。 包的名称由一个小写字母序列组成。 类的名称由大写字母开头,其他字母都由小写的单词组成。 类的实例的名称由一个小写字母开头,后面的单词由大写字母开头。 常量的名称都大写,并且指出完整含义。 参数的名称无其他具体规定。