代码规范

2016-01-18  本文已影响108人  David_Cap

命名规范

总的来说, iOS命名两大原则是:可读性高和防止命名冲突(通过加前缀来保证). Objective-C 的命名通常都比较长, 名称遵循驼峰式命名法

常量

对于常量命名最好在前面加上字母k作为标记,例如:

static const NSTimeInterval kAnimationDuration = 0.3;

Tips:

#define 宏定义

static 静态

const 常量

区别

宏: 宏定义只是简单的文本替换,没有任何类型信息。宏就是把源代码中用到这个宏的地方进行一个简单的文本替换。

常量:

四种写法:
static const NSString *DDString = @"女神大人,么么哒";
const NSString *DDString = @"女神大人,么么哒";
NSString const *DDString = @"女神大人,么么哒";
NSString * const DDString = @"女神大人,么么哒";

这几种有什么区别呢,简单点说就是 const 右边的东西 不能修改。

例如:

//这个表示 *DDString 这个指针不能修改
NSString const *DDString = @"女神大人,么么哒";
//这个表示 DDString 这个字符串内容不能修改,所以应该采用这种
NSString * const DDString = @"女神大人,么么哒";

如果加上Static 就是只能在本类里面访问。如果没有加,还可以通过extern来访问。

enum的书写

如果如下书写enum.

typedef NS_ENUM(NSInteger, UIViewAnimationTransition) {
    UIViewAnimationTransitionNone,
    UIViewAnimationTransitionFlipFromLeft,
    UIViewAnimationTransitionFlipFromRight,
    UIViewAnimationTransitionCurlUp,
    UIViewAnimationTransitionCurlDown,
};

这边需要注意的是: 枚举类型命名要加相关类名前缀并且枚举值命名要加枚举类型前缀.

变量和对象的命名

给一个对象命名一般遵循: 修饰 + 类型。

例如

titleLabel
confirmButton
XXXArray
XXXDictionary

编程规范

为了保持编程的dry,要尽量把重复部分封装起来。

下面推荐的一些小细节的编程规范吧。

  1. 判断nil或者YES/NO
Preferred:
    if (someObject) { ... } 
    if (!someObject) { ... }
    
Not preferred:
    if (someObject == YES) { ...} 
    if (someObject != nil) { ...}

if (someObject == YES)容易误写成赋值语句, 自己给自己挖坑了...而且if (someObject)写法很简洁, 何乐而不为呢?

  1. 条件赋值
Preferred:
    result = object ? : [self createObject];

Not preferred:
    result = object ? object : [self createObject];
  1. 初始化方法
Perferred:
    NSArray *names = @[@"Brian", @"Matt", @"Chris", @"Alex", @"Steve"];
    NSDictionary *productManagers = @{@"iPhone" : @"Kate", @"iPad" : @"Kamal"};
    NSNumber *shouldUseLiterals = @YES;
    NSNumber *buildingZIPCode = @10018;

初始化多用字面量方法一直是提倡的行为。

  1. BOOL 赋值
Preferred:
    BOOL isAdult = age > 18;

Not preferred:
    BOOL isAdult;
    if (age > 18)
    {
        isAdult = YES;
    }
    else
    {
        isAdult = NO;
    }

  1. 拒绝死值
Preferred:
    if (car == Car.Nissan)
    
    const int adultAge = 18;
    if (age > adultAge) { ... }

Not preferred:
    if (carName == "Nissan")

    if (age > 18) { ... }
  1. weakSelf 防止循环引用
__weak typeof(self) weakSelf = self;
dispatch_block_t block =  ^{
    [weakSelf doSomething]; // weakSelf != nil
    // preemption, weakSelf turned nil
    [weakSelf doSomethingElse]; // weakSelf == nil
};

参考

http://www.cocoachina.com/ios/20151014/13678.html
这篇持续更新,慢慢积累.......

上一篇 下一篇

猜你喜欢

热点阅读