美文网首页
代码规范

代码规范

作者: David_Cap | 来源:发表于2016-01-18 16:10 被阅读108次

命名规范

总的来说, 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
这篇持续更新,慢慢积累.......

相关文章

  • Web 端代码规范

    目录 1、代码规范概述 2、代码规范流程搭建 3、代码规范细则 1、代码规范概述 良好的代码规范能够提供软件的可读...

  • 代码规范

    代码规范 1. 概述 欢迎使用前端代码规范, 这里借鉴、引用的是京东前端代码规范。 遵循代码规范的目的在于增强团队...

  • iOS 代码规范篇

    iOS 代码规范篇 iOS 代码规范篇

  • iOS(OC)开发之随感

    1.代码规范 规范很重要!规范很重要!规范很重要! 代码规范的重要性之-为什么谷歌要执行严格的代码编写规范http...

  • 前端学习的基本总结

    目录 1.为什要遵守代码规范 2.css代码规范 3.js代码规范与设计模式3.1 js代码规范3.2 设计模式 ...

  • 乐乎项目优化

    编程: 1、代码规范。架构规范、文件组织规范、命名规范、代码逻辑规范、资源存放。 一、使用cocoapod 二、代...

  • 小肤iOS开发代码规范_v1.0

    For Objective-C , 2018.8.2 Ⅰ.前言Ⅱ.命名规范Ⅲ.代码注释规范Ⅳ.代码格式化规范Ⅴ....

  • 代码规范

    代码规范 1. 概述 欢迎使用代码规范, 这个是我借鉴京东前端代码规范,组织的内部规范。旨在增强团队开发协作、提高...

  • PSR-2- Coding Style Guide 编码风格规范

    代码风格规范 本篇规范是 PSR-1 基本代码规范的继承与扩展。 本规范希望通过制定一系列规范化PHP代码的规则,...

  • PM篇

    PM 技术篇1.开发规范命名规范,异常处理规范,日志规范,统一框架,代码commit规范,代码评审规范,统一API...

网友评论

      本文标题:代码规范

      本文链接:https://www.haomeiwen.com/subject/ouykkttx.html