Objective-C编码规范[译]

在四个人支付同一个app时,倘诺每一个人的Objective-C编码风格都不一致,那样不易于保持代码一致性难以Code
Review
。所以自个儿在网上查找到 The official raywenderlich.com Objective-C
style
guide
那篇有关Objective-C编码风格的小说,觉得能够当做这一个类其余Objective-C的编码标准,所以就翻译那篇小说。

raywenderlich.com Objective-C编码规范

那篇编码风格指南概括了raywenderlich.com的编码规范,恐怕有点删减或改动。

介绍

小编们制订Objective-C编码规范的原故是我们可以在大家的书,教程和初学者工具包的代码保持优雅和同等。即使大家有无数不一致的撰稿人来形成差距的图书。

此间编码规范有恐怕与您看到的其余Objective-C编码规范不同,因为它最重如若为了打印和web的易读性。

关于我

那编码规范的成立是由许多起点raywenderlich.com团队成员在NicholasWaynik的引导下共同已毕的。团队成员有:Soheil Moayedi
Azarpour
,
Ricardo Rendon
Cepeda
,
Tony Dahbura,
Colin
Eberhardt
,
Matt
Galloway
,
Greg Heo,
Matthijs
Hollemans
,
Christopher
LaPollo
,
Saul Mora,
Andy Pereira,
Mic Pringle,
Pietro Rea,
Cesare Rocchi,
Marin Todorov,
Nicholas
Waynik
Ray
Wenderlich

咱俩也非凡多谢New York
Times

Robots &
Pencils’
Objective-C编码规范的撰稿人。那四个编码规范为本指南的成立提供很好的源点。

背景

此处有些关于编码风格Apple官方文档,假诺有点东西平素不提及,可以在偏下文档来寻觅越来越多细节:

目录

<b id=”language”></b>

语言

有道是选用US波兰语.

应该:

UIColor *myColor = [UIColor whiteColor];

不应该:

UIColor *myColour = [UIColor whiteColor];

<b id=”code-organization”></b>

代码协会

在函数分组和protocol/delegate落成中拔取#pragma mark -来分类方法,要听从以下一般结构:

#pragma mark - Lifecycle

- (instancetype)init {}
- (void)dealloc {}
- (void)viewDidLoad {}
- (void)viewWillAppear:(BOOL)animated {}
- (void)didReceiveMemoryWarning {}

#pragma mark - Custom Accessors

- (void)setCustomProperty:(id)value {}
- (id)customProperty {}

#pragma mark - IBActions

- (IBAction)submitData:(id)sender {}

#pragma mark - Public

- (void)publicMethod {}

#pragma mark - Private

- (void)privateMethod {}

#pragma mark - Protocol conformance
#pragma mark - UITextFieldDelegate
#pragma mark - UITableViewDataSource
#pragma mark - UITableViewDelegate

#pragma mark - NSCopying

- (id)copyWithZone:(NSZone *)zone {}

#pragma mark - NSObject

- (NSString *)description {}

<b id=”spacing”></b>

空格

  • 缩进使用4个空格,确保在Xcode偏好设置来设置。(raywenderlich.com使用2个空格)
  • 措施大括号和任何大括号(if/else/switch/while
    等.)总是在相同行语句打开但在新行中关闭。

应该:

if (user.isHappy) {
    //Do something
} else {
    //Do something else
}

不应该:

if (user.isHappy)
{
  //Do something
}
else {
  //Do something else
}
  • 在章程之间应该有且唯有一行,那样有利于在视觉上更显著和更易于协会。在艺术内的空白应该分别功用,但一般都抽离出来改成一个新办法。
  • 先行利用auto-synthesis。但假若有必不可少,@synthesize
    @dynamic有道是在促成中每一个都宣称新的一行。
  • 相应防止以冒号对齐的不二法门来调用方法。因为偶然方法签名大概有3个以上的冒号和冒号对齐会使代码特别易读。请不要诸如此类做,即使冒号对齐的主意包蕴代码块,因为Xcode的对齐形式令它难以辨认。

应该:

// blocks are easily readable
[UIView animateWithDuration:1.0 animations:^{
  // something
} completion:^(BOOL finished) {
  // something
}];

不应该:

// colon-aligning makes the block indentation hard to read
[UIView animateWithDuration:1.0
                 animations:^{
                     // something
                 }
                 completion:^(BOOL finished) {
                     // something
                 }];

<b id=”comments”></b>

注释

当须要注释时,注释应该用来解释那段特殊代码为什么要如此做。任何被选择的笺注都必须保持最新或被删除。

诚如都防止使用块注释,因为代码尽只怕完毕自解释,唯有当断断续续或几行代码时才必要注释。不等:那不应用在转变文档的注释

<b id=”naming”></b>

命名

Apple命名规则尽或者百折不挠,特别是与那几个相关的memory management
rules

(NARC)。

长的,描述性的办法和变量命名是好的。

应该:

UIButton *settingsButton;

不应该:

UIButton *setBut;

多少个字符前缀应该时时用在类和常量命名,但在Core
Data的实体名中应被忽视。对于合法的raywenderlich.com书、初学者工具包或课程,前缀’EnclaveWT’应该被利用。

常量应该采纳驼峰式命名规则,所有的单词首字母大写和增加与类名有关的前缀。

应该:

static NSTimeInterval const RWTTutorialViewControllerNavigationFadeAnimationDuration = 0.3;

不应该:

static NSTimeInterval const fadetime = 1.7;

质量也是使用驼峰式,但首单词的首字母小写。对质量使用auto-synthesis,而不是手动编写@
synthesize语句,除非您有一个好的说辞。

应该:

@property (strong, nonatomic) NSString *descriptiveVariableName;

不应该:

id varnm;

<b id=”underscores”></b>

下划线

当使用品质时,实例变量应该运用self.来走访和改变。那就象征所有属性将会视觉效果不一样,因为它们前边都有self.

但有一个特例:在开端化方法里,实例变量(例如,_variableName)应该平昔被应用来避免getters/setters潜在的副功效。

有的变量不该包罗下划线。

<b id=”methods”></b>

方法

在章程签名中,应该在措施类型(-/+
符号)之后有一个空格。在艺术各样段时期应该也有一个空格(符合Apple的风格)。在参数此前应当包涵一个负有描述性的要紧字来叙述参数。

“and”这一个词的用法应该保留。它不该用于多个参数来表明,就如initWithWidth:height以下这一个例子:

应该:

- (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.

<b id=”variables”></b>

变量

变量尽量以描述性的艺术来定名。单个字符的变量命名应该尽量防止,除了在for()循环。

星号表示变量是指针。例如, NSString *text 既不是 NSString* text
也不是 NSString * text,除了有的与众分裂意况下常量。

个体变量
应该尽只怕代替实例变量的利用。固然选用实例变量是一种有效的不二法门,但更偏向于采纳质量来保持代码一致性。

透过动用’back’属性(_variable,变量名前边有下划线)直接访问实例变量应该尽量幸免,除了在发轫化方法(init,
initWithCoder:, 等…),dealloc
方法和自定义的setters和getters。想询问有关怎么样在初叶化方法和dealloc间接选拔Accessor方法的越来越多音讯,查看这里

应该:

@interface RWTTutorial : NSObject

@property (strong, nonatomic) NSString *tutorialName;

@end

不应该:

@interface RWTTutorial : NSObject {
  NSString *tutorialName;
}

<b id=”property-attributes”></b>

品质性情

怀有属性个性应该显式地列出来,有助于新手阅读代码。属性性子的一一应该是storage、atomicity,与在Interface
Builder连接UI成分时自动生成代码一致。

应该:

@property (weak, nonatomic) IBOutlet UIView *containerView;
@property (strong, nonatomic) NSString *tutorialName;

不应该:

@property (nonatomic, weak) IBOutlet UIView *containerView;
@property (nonatomic) NSString *tutorialName;

NSString应该使用copy 而不是 strong的性质天性。

何以?固然你声美素佳儿个NSString的属性,有人或者传播一个NSMutableString的实例,然后在你从未放在心上的图景下修改它。

应该:

@property (copy, nonatomic) NSString *tutorialName;

不应该:

@property (strong, nonatomic) NSString *tutorialName;

<b id=”dot-notation-syntax”></b>

点符号语法

点语法是一种很便利包装访问方法调用的方法。当您使用点语法时,通过采用getter或setter方法,属性仍旧被访问或改动。想明白越多,阅读这里

点语法应该总是被用来访问和改动属性,因为它使代码更加简明。[]标记更偏向于用在其他例子。

应该:

NSInteger arrayCount = self.array.count;
view.backgroundColor = [UIColor orangeColor];
[UIApplication sharedApplication].delegate;

不应该:

NSInteger arrayCount = [self.array count];
[view setBackgroundColor:[UIColor orangeColor]];
[[UIApplication sharedApplication] delegate];

<b id=”literals”></b>

字面值

NSString, NSDictionary, NSArray, 和
NSNumber的字面值应该在创造那么些类的不可变实例时被运用。请特别注意nil值无法传遍NSArrayNSDictionary字面值,因为这么会造成crash。

应该:

NSArray *names = @[@"Brian", @"Matt", @"Chris", @"Alex", @"Steve", @"Paul"];
NSDictionary *productManagers = @{@"iPhone": @"Kate", @"iPad": @"Kamal", @"Mobile Web": @"Bill"};
NSNumber *shouldUseLiterals = @YES;
NSNumber *buildingStreetNumber = @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 *buildingStreetNumber = [NSNumber numberWithInteger:10018];

<b id=”constants”></b>

常量

常量是简单重新被运用和无需通过查找和顶替就能很快修改值。常量应该使用static来声称而不是使用#define,除非显式地使用宏。

应该:

static NSString * const RWTAboutViewControllerCompanyName = @"RayWenderlich.com";

static CGFloat const RWTImageThumbnailHeight = 50.0;

不应该:

#define CompanyName @"RayWenderlich.com"

#define thumbnailHeight 2

<b id=”enumerated-types”></b>

枚举类型

当使用enum时,推荐使用新的一定基本类型标准,因为它有更强的类型检查和代码补全。将来SDK有一个宏NS_ENUM()来协理和鞭策你利用一定的为主类型。

例如:

typedef NS_ENUM(NSInteger, RWTLeftMenuTopItemType) {
  RWTLeftMenuTopItemMain,
  RWTLeftMenuTopItemShows,
  RWTLeftMenuTopItemSchedule
};

你也得以显式地赋值(体现旧的k-style常量定义):

typedef NS_ENUM(NSInteger, RWTGlobalConstants) {
  RWTPinSizeMin = 1,
  RWTPinSizeMax = 5,
  RWTPinCountMin = 100,
  RWTPinCountMax = 500,
};

旧的k-style常量定义应该避免只有编写Core Foundation C的代码。

不应该:

enum GlobalConstants {
  kMaxPinSize = 5,
  kMaxPinCount = 500,
};

<b id=”case-statements”></b>

Case语句

大括号在case语句中并不是必须的,除非编译器强制须求。当一个case语句包罗多行代码时,大括号应该加上。

switch (condition) {
  case 1:
    // ...
    break;
  case 2: {
    // ...
    // Multi-line example using braces
    break;
  }
  case 3:
    // ...
    break;
  default: 
    // ...
    break;
}

有好数次,当相同代码被七个cases使用时,一个fall-through应该被应用。一个fall-through就是在case最终移除’break’语句,那样就可以允许实施流程跳转到下一个case值。为了代码尤其显明,一个fall-through须要注释一下。

switch (condition) {
  case 1:
    // ** fall-through! **
  case 2:
    // code executed for values 1 and 2
    break;
  default: 
    // ...
    break;
}

当在switch使用枚举类型时,’default’是不必要的。例如:

RWTLeftMenuTopItemType menuType = RWTLeftMenuTopItemMain;

switch (menuType) {
  case RWTLeftMenuTopItemMain:
    // ...
    break;
  case RWTLeftMenuTopItemShows:
    // ...
    break;
  case RWTLeftMenuTopItemSchedule:
    // ...
    break;
}

<b id=”private-properties”></b>

私家属性

村办属性应该在类的落到实处公文中的类增加(匿名分类)中扬言,命名分类(比如RWTPrivateprivate)应该没有使用除非是扩展其余类。匿名分类应该通过运用<headerfile>+Private.h文件的命名规则暴光给测试。

例如:

@interface RWTDetailViewController ()

@property (strong, nonatomic) GADBannerView *googleAdView;
@property (strong, nonatomic) ADBannerView *iAdView;
@property (strong, nonatomic) UIWebView *adXWebView;

@end

<b id=”booleans”></b>

布尔值

Objective-C使用YESNO。因为truefalse应该只在CoreFoundation,C或C++代码使用。既然nil解析成NO,所以并未必要在尺度语句相比。不要拿某样东西间接与YES比较,因为YES被定义为1和一个BOOL能被安装为8位。

那是为着在分化文件保持一致性和在视觉上更为简洁而考虑。

应该:

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

不应该:

if (someObject == nil) {}
if ([anotherObject boolValue] == NO) {}
if (isAwesome == YES) {} // Never do this.
if (isAwesome == true) {} // Never do this.

如果BOOL性子的名字是一个形容词,属性就能忽视”is”前缀,但要指定get访问器的惯用名称。例如:

@property (assign, getter=isEditable) BOOL editable;

文字和例子从此间引用Cocoa Naming
Guidelines

<b id=”conditionals”></b>

规范语句

标准化语句主体为了预防出错应该选用大括号包围,尽管条件语句主体可以不用大括号编写(如,只用一行代码)。那个不当包罗丰盛第二行代码和期待它成为if语句;还有,even
more dangerous
defect
兴许发生在if语句里面一行代码被诠释了,然后下一行代码不知不觉地成为if语句的一局部。除此之外,这种作风与任何条件语句的风骨保持一致,所以进一步简单阅读。

应该:

if (!error) {
  return success;
}

不应该:

if (!error)
  return success;

if (!error) return success;

<b id=”ternary-operator”></b>

元正操作符

当要求增强代码的清晰性和简洁性时,长富操作符?:才会选取。单个条件求值日常需求它。三个规范求值时,如果选用if言辞或重构成实例变量时,代码会特别易读。一般的话,最好使用安慕希操作符是在依照规则来赋值的情状下。

Non-boolean的变量与某东西相比,加上括号()会升高可读性。如果被比较的变量是boolean类型,那么就不需求括号。

应该:

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

BOOL isHorizontal = YES;
result = isHorizontal ? x : y;

不应该:

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

<b id=”init-methods”></b>

Init方法

Init方法应该依据Apple生成代码模板的命名规则。再次回到类型应该运用instancetype而不是id

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

查阅关于instancetype的篇章Class Constructor
Methods

<b id=”class-constructor-methods”></b>

类构造方法

当类构造方法被应用时,它应当回到类型是instancetype而不是id。那样保险编译器正确地想见结果类型。

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

关于越多instancetype音信,请查看NSHipster.com

<b id=”cgrect-functions”></b>

CGRect函数

当访问CGRect里的x, y, width, 或
height时,应该运用CGGeometry函数而不是直接通过结构体来访问。引用Apple的CGGeometry:

在这一个参考文档中保有的函数,接受CGRect结构体作为输入,在盘算它们结果时隐式地条件那么些rectangles。因而,你的应用程序应该幸免直接访问和修改保存在CGRect数据结构中的数据。相反,使用那些函数来操纵rectangles和得到它们的性状。

应该:

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 };

<b id=”golden-path”></b>

黄金路线

当使用规则语句编码时,左手边的代码应该是”golden” 或
“happy”路径。相当于不用嵌套if说话,七个重返语句也是OK。

应该:

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

  //Do something important
}

不应该:

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

<b id=”error-handling”></b>

错误处理

当方法通过引用来回到一个谬误参数,判断重临值而不是不对变量。

应该:

NSError *error;
if (![self trySomethingWithError:&error]) {
  // Handle Error
}

不应该:

NSError *error;
[self trySomethingWithError:&error];
if (error) {
  // Handle Error
}

在功成名就的场地下,有些Apple的APIs记录垃圾值(garbage
values)到错误参数(若是non-NULL),那么判断错误值会招致false负值和crash。

<b id=”singletons”></b>

单例情势

单例对象应当利用线程安全格局来创建共享实例。

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

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

  return sharedInstance;
}

那会幸免possible and sometimes prolific
crashes
.

<b id=”line-breaks”></b>

换行符

换行符是一个很要紧的宗旨,因为它的作风指南首要为了打印和网上的可读性。

例如:

self.productsRequest = [[SKProductsRequest alloc] initWithProductIdentifiers:productIdentifiers];

一行非常长的代码应该分为两行代码,下一行用五个空格隔开。

self.productsRequest = [[SKProductsRequest alloc] 
  initWithProductIdentifiers:productIdentifiers];

<b id=”xcode-project”></b>

Xcode工程

物理文件应该与Xcode工程文件保持同步来防止文件扩大。任何Xcode分组的创办应该在文件系统的文书突显。代码不仅是基于类型来分组,而且仍可以依据功能来分组,那样代码尤其鲜明。

尽量在target的Build Settings打开”Treat Warnings as
Errors,和启用以下additional
warnings
。假使您需求忽略特殊的警示,使用
Clang’s pragma
feature

任何Objective-C编码规范

比方大家的编码规范不适合您的意气,可以查阅其余的编码规范: