ios

移动端iOS开发规范文档

2017-05-01  本文已影响1008人  志城

移动端iOS开发规范文档

目录

https://github.com/NYTimes/objective-c-style-guide


1. 格式与换行

1.1 使用Xcode默认的设置使用4个空格来缩进。

1.2 方法长度不操作100行,建议不超过80行,如果方法太长可以考虑提 取其中的一部分。

1.3 方法-和方法+和返回值前面的左括号间隔一个空格,方法参数直接间隔一个空格。

1.4 条件语句的格式采用苹果推荐的代码缩进方式。


2. 命名

2.1 命名统一使用驼峰命名法;只采纳有广为人知含义的缩写,比如info、msg、UI、HTTP这类。自造的缩写不被认可。总体的命名原则是清晰和一致,避免歧义。

2.2 类名需要结合项目名称来命名,确保整个项目中的自定义类的名称开头是统一的,同样要确保类名需要大写字母开头。

2.3 类名命名需结合功能或者模块,并且尾部要带上该类的类型,比如UIViewController的子类命名为JasonIndexViewController

2.4 方法命名小写字母开头(方法以大写缩略词开始的除外),文件夹首字母大写开头。不要使用下划线开头作为方法的前缀。

2.5 定义类的变量,不需要暴露的变量均放在实现文件里定义,同时视图类变量,在类扩展下定义成属性。数据类的变量定义在@implementation下的大括号内。同时注意:局部变量不应该包含下划线。


3. Objective-C下的cocoa编码规范

3.1 使用#pragma mark 来分类方法,参考以下结构

#pragma mark – Life Cycle

#pragma mark - Events

#pragma mark – Private Methods

#pragma mark - UITextFieldDelegate

#pragma mark - UITableViewDataSource

#pragma mark - UITableViewDelegate

#pragma mark - Custom Delegates

#pragma mark – Getters and Setters

3.2 重载系统方法的时候,如无特殊情况均需要先调用super的方法。

3.3 属性必须指定其类型,比如(nonatomic,strong)

3.4 使用#import引入oc/oc++文件,使用#include引入c/c++文件

3.5 尽量减少公开的api接口数量。

3.6 枚举的定义使用如下的方式

typedef NS_ENUM(NSUInteger, UISearchBarStyle) {
    UISearchBarStyleDefault,    // currently UISearchBarStyleProminent
    UISearchBarStyleProminent,  // used my Mail, Messages and Contacts
    UISearchBarStyleMinimal     // used by Calendar, Notes and Music
}

4 注释要求

4.1 新版Xcode自带有添加注释的功能

4.2 在新建一个类的时候,需要在头文件中添加注释,来表明这个类的作用。

4.3 在创建接口类的时候,同样需要在头文件添加注释,来表明这个类的用处。

4.4 一些过于简单的注释尽量不要加。


5 其他

5.1 ifcase语句

if (!error) {
  return success;
}

if (!error)
  return success;
或  
if (!error) return success;

5.2 布尔值

if (someObject) {
    //...
}
if (![anotherObject boolValue]) {
    //...
}

5.3 三元操作符

NSInteger value = 5;
result = (value != 0) ? x : y;

BOOL isHorizontal = YES;
result = isHorizontal ? x : y;
result = a > b ? x = c > d ? c : d : y;

5.4 Init方法

- (instancetype)init {
  self = [super init];
  if (self) {
    // ...
  }
  return self;
}

5.5 类构造方法

@interface Airplane
+ (instancetype)airplaneWithType:(RWTAirplaneType)type;
@end

5.6 CGRect函数

CGRect frame = self.view.frame;

CGFloat x = CGRectGetMinX(frame);
CGFloat y = CGRectGetMinY(frame);
CGFloat width = CGRectGetWidth(frame);
CGFloat height = CGRectGetHeight(frame);
CGRect frame = CGRectMake(0.0, 0.0, width, height);
CGRect frame = self.view.frame;

CGFloat x = frame.origin.x;
CGFloat y = frame.origin.y;
CGFloat width = frame.size.width;
CGFloat height = frame.size.height;
CGRect frame = (CGRect){ .origin = CGPointZero, .size = frame.size };


5.7 黄金路径

- (void)someMethod {
  if (![someOther boolValue]) {
    return;
  }

  //Do something important
}
- (void)someMethod {
  if ([someOther boolValue]) {
    //Do something important
  }
}

5.8 单例模式

+ (instancetype)sharedInstance {
  static id sharedInstance = nil;

  static dispatch_once_t onceToken;
  dispatch_once(&onceToken, ^{
    sharedInstance = [[self alloc] init];
  });

  return sharedInstance;
}

5.9 布局中的空格

@interface SomeClass:NSObject

@property (noatomic, strong) UIView *aView

- (void)someMethod;

@end

@implementation SomeClass

- (void)setAView:(NSInteger )aview {

}

- (void)someMethod {

}
@end

5.10 Getters and Setters放在最底部


6 参考文档

未尽事项可参考以下连接

上一篇下一篇

猜你喜欢

热点阅读