Objective-C编码规范:26个方面解决iOS开发问题

Objective-C编码规范:26个方面解决iOS开发问题

发表于 2015-06-02 10:3217894次阅读| 来源 CSDN34 条评论| 作者 刘耀柱
allowtransparency="true" frameborder="0" scrolling="no" src="http://hits.sinajs.cn/A1/weiboshare.html?url=http%3A%2F%2Fwww.csdn.net%2Farticle%2F2015-06-01%2F2824818-objective-c-style-guide%2F1&type=3&count=&appkey=&title=%E8%8B%B9%E6%9E%9C%E5%85%AC%E5%8F%B8%E5%B7%B2%E7%BB%8F%E6%9C%89%E4%B8%80%E4%BB%BD%E9%9D%9E%E5%B8%B8%E5%85%A8%E9%9D%A2%E7%9A%84Objective-C%E7%BC%96%E7%A0%81%E6%8C%87%E5%8D%97%EF%BC%8CGoogle%E3%80%81GitHub%E3%80%81New%20York%20Times%E7%AD%89%E4%B9%9F%E5%9D%87%E5%8F%91%E5%B8%83%E4%BA%86%E5%85%B6iOS%E5%9B%A2%E9%98%9F%E4%BD%BF%E7%94%A8%E8%A7%84%E8%8C%83%E3%80%82%E6%9C%AC%E6%96%87%E8%AF%91%E8%80%85%E5%AF%B9raywenderlich.com%E5%9B%A2%E9%98%9F%E7%9A%84Objective-C%E7%BC%96%E7%A0%81%E9%A3%8E%E6%A0%BC%E8%A7%84%E8%8C%83%E8%BF%9B%E8%A1%8C%E4%BA%86%E7%BF%BB%E8%AF%91%E3%80%82&pic=&ralateUid=&language=zh_cn&rnd=1446373701721" width="22" height="16"> 摘要:苹果公司已经有一份非常全面的Objective-C编码指南,Google、GitHub、New York Times等也均发布了其iOS团队使用规范。本文译者对raywenderlich.com团队的Objective-C编码风格规范进行了翻译。

【按语】由于我正在准备模拟开发饿了么这个App,到时可能有些iOS开发者参与进来。这时如果每个人的Objective-C编码风格都不一样,这样不易于保持代码一致性和难以Code Review。所以我在网上搜索到The official raywenderlich.com Objective-C style guide这篇关于Objective-C编码风格的文章,觉得可以作为这个项目的Objective-C的编码标准,所以就翻译这篇文章。这篇编码风格指南概括了raywenderlich.com的编码规范,可能有些删减或修改。

介绍

我们制定Objective-C编码规范的原因是我们能够在我们的书,教程和初学者工具包的代码保持优雅和一致。即使我们有很多不同的作者来完成不同的书籍。

这里编码规范有可能与你看到的其他Objective-C编码规范不同,因为它主要是为了打印和Web的易读性。

关于作者

这编码规范的创建是由很多来自raywenderlich.com团队成员在Nicholas Waynik的带领下共同完成的。团队成员有:Soheil Moayedi AzarpourRicardo Rendon CepedaTony DahburaColin EberhardtMatt GallowayGreg HeoMatthijs HollemansChristopher LaPolloSaul MoraAndy PereiraMic PringlePietro ReaCesare RocchiMarin TodorovNicholas WaynikRay Wenderlich

我们也非常感谢New York Times 和Robots & Pencils'Objective-C编码规范的作者。这两个编码规范为本指南的创建提供很好的起点。

背景

这里有些关于编码风格Apple官方文档,如果有些东西没有提及,可以在以下文档来查找更多细节:

语言

应该使用US英语。

应该:

[cpp]  view plain copy
  1. UIColor *myColor = [UIColor whiteColor];  

不应该:

[cpp]  view plain copy
  1. UIColor *myColour = [UIColor whiteColor];  

代码组织

在函数分组和protocol/delegate实现中使用#pragma mark -来分类方法,要遵循以下一般结构:

[cpp]  view plain copy
  1. #pragma mark - Lifecycle  
  2. - (instancetype)init {}  
  3. - (void)dealloc {}  
  4. - (void)viewDidLoad {}  
  5. - (void)viewWillAppear:(BOOL)animated {}  
  6. - (void)didReceiveMemoryWarning {}  
  7. #pragma mark - Custom Accessors  
  8. - (void)setCustomProperty:(id)value {}  
  9. - (id)customProperty {}  
  10. #pragma mark - IBActions  
  11. - (IBAction)submitData:(id)sender {}  
  12. #pragma mark - Public  
  13. - (void)publicMethod {}  
  14. #pragma mark - Private  
  15. - (void)privateMethod {}  
  16. #pragma mark - Protocol conformance  
  17. #pragma mark - UITextFieldDelegate  
  18. #pragma mark - UITableViewDataSource  
  19. #pragma mark - UITableViewDelegate  
  20. #pragma mark - NSCopying  
  21. - (id)copyWithZone:(NSZone *)zone {}  
  22. #pragma mark - NSObject  
  23. - (NSString *)description {}  

空格

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

应该:

[cpp]  view plain copy
  1. if (user.isHappy) {  
  2.     //Do something  
  3. else {  
  4.     //Do something else  
  5. }  

不应该:

[cpp]  view plain copy
  1. if (user.isHappy)  
  2. {  
  3.   //Do something  
  4. }  
  5. else {  
  6.   //Do something else  
  7. }  

  • 在方法之间应该有且只有一行,这样有利于在视觉上更清晰和更易于组织。在方法内的空白应该分离功能,但通常都抽离出来成为一个新方法。
  • 优先使用auto-synthesis。但如果有必要,@synthesize和@dynamic应该在实现中每个都声明新的一行。
  • 应该避免以冒号对齐的方式来调用方法。因为有时方法签名可能有3个以上的冒号和冒号对齐会使代码更加易读。请不要这样做,尽管冒号对齐的方法包含代码块,因为Xcode的对齐方式令它难以辨认。

应该:

[cpp]  view plain copy
  1. // blocks are easily readable  
  2. [UIView animateWithDuration:1.0 animations:^{  
  3.   // something  
  4. } completion:^(BOOL finished) {  
  5.   // something  
  6. }];  

不应该:

[cpp]  view plain copy
  1. // colon-aligning makes the block indentation hard to read  
  2. [UIView animateWithDuration:1.0  
  3.                  animations:^{  
  4.                      // something  
  5.                  }  
  6.                  completion:^(BOOL finished) {  
  7.                      // something  
  8.                  }];  

注释

当需要注释时,注释应该用来解释这段特殊代码为什么要这样做。任何被使用的注释都必须保持最新或被删除。

一般都避免使用块注释,因为代码尽可能做到自解释,只有当断断续续或几行代码时才需要注释。例外:这不应用在生成文档的注释

命名

Apple命名规则尽可能坚持,特别是与这些相关的memory management rules (NARC)。

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

应该:

[cpp]  view plain copy
  1. UIButton *settingsButton;  

不应该:

[cpp]  view plain copy
  1. UIButton *setBut;  

三个字符前缀应该经常用在类和常量命名,但在Core Data的实体名中应被忽略。对于官方的raywenderlich.com书、初学者工具包或教程,前缀'RWT'应该被使用。

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

应该:

[cpp]  view plain copy
  1. static NSTimeInterval const RWTTutorialViewControllerNavigationFadeAnimationDuration = 0.3;  

不应该:

[cpp]  view plain copy
  1. static NSTimeInterval const fadetime = 1.7;  

属性也是使用驼峰式,但首单词的首字母小写。对属性使用auto-synthesis,而不是手动编写@synthesize语句,除非你有一个好的理由。

下划线

当使用属性时,实例变量应该使用self.来访问和改变。这就意味着所有属性将会视觉效果不同,因为它们前面都有self.。

但有一个特例:在初始化方法里,实例变量(例如,_variableName)应该直接被使用来避免getters/setters潜在的副作用。

局部变量不应该包含下划线。

方法

在方法签名中,应该在方法类型(-/+ 符号)之后有一个空格。在方法各个段之间应该也有一个空格(符合Apple的风格)。在参数之前应该包含一个具有描述性的关键字来描述参数。

"and"这个词的用法应该保留。它不应该用于多个参数来说明,就像initWithWidth:height以下这个例子:

应该:

[cpp]  view plain copy
  1. - (void)setExampleText:(NSString *)text image:(UIImage *)image;  
  2. - (void)sendAction:(SEL)aSelector to:(id)anObject forAllCells:(BOOL)flag;  
  3. - (id)viewWithTag:(NSInteger)tag;  
  4. - (instancetype)initWithWidth:(CGFloat)width height:(CGFloat)height;  

不应该:

[cpp]  view plain copy
  1. -(void)setT:(NSString *)text i:(UIImage *)image;  
  2. - (void)sendAction:(SEL)aSelector :(id)anObject :(BOOL)flag;  
  3. - (id)taggedView:(NSInteger)tag;  
  4. - (instancetype)initWithWidth:(CGFloat)width andHeight:(CGFloat)height;  
  5. - (instancetype)initWith:(int)width and:(int)height;  // Never do this.  

变量

变量尽量以描述性的方式来命名。单个字符的变量命名应该尽量避免,除了在for()循环。

星号表示变量是指针。例如, NSString *text 既不是 NSString* text 也不是 NSString * text,除了一些特殊情况下常量。

私有变量应该尽可能代替实例变量的使用。尽管使用实例变量是一种有效的方式,但更偏向于使用属性来保持代码一致性。

通过使用'back'属性(_variable,变量名前面有下划线)直接访问实例变量应该尽量避免,除了在初始化方法(init, initWithCoder:, 等…),dealloc 方法和自定义的setters和getters。想了解关于如何在初始化方法和dealloc直接使用Accessor方法的更多信息,查看这里

应该:

[cpp]  view plain copy
  1. @interface RWTTutorial : NSObject  
  2. @property (strong, nonatomic) NSString *tutorialName;  
  3. @end  

不应该:

[cpp]  view plain copy
  1. @interface RWTTutorial : NSObject {  
  2.   NSString *tutorialName;  
  3. }  

属性特性

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

应该:

[cpp]  view plain copy
  1. @property (weak, nonatomic) IBOutlet UIView *containerView;  
  2. @property (strong, nonatomic) NSString *tutorialName;  

不应该:

[cpp]  view plain copy
  1. @property (nonatomic, weak) IBOutlet UIView *containerView;  
  2. @property (nonatomic) NSString *tutorialName;  

NSString应该使用copy而不是strong的属性特性。

为什么?即使你声明一个NSString的属性,有人可能传入一个NSMutableString的实例,然后在你没有注意的情况下修改它。

应该:

[cpp]  view plain copy
  1. @property (copy, nonatomic) NSString *tutorialName;  

不应该:

[cpp]  view plain copy
  1. @property (strong, nonatomic) NSString *tutorialName;  

点符号语法

点语法是一种很方便封装访问方法调用的方式。当你使用点语法时,通过使用getter或setter方法,属性仍然被访问或修改。想了解更多,阅读这里

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

应该:

[cpp]  view plain copy
  1. objc  
  2. NSInteger arrayCount = [self.array count];  
  3. view.backgroundColor = [UIColor orangeColor];  
  4. [UIApplication sharedApplication].delegate;  

不应该:

[cpp]  view plain copy
  1. NSInteger arrayCount = self.array.count;  
  2. [view setBackgroundColor:[UIColor orangeColor]];  
  3. UIApplication.sharedApplication.delegate;  

字面值

NSString、NSDictionary、NSArray和NSNumber的字面值应该在创建这些类的不可变实例时被使用。请特别注意nil值不能传入NSArray和NSDictionary字面值,因为这样会导致crash。

应该:

[cpp]  view plain copy
  1. NSArray *names = @[@"Brian", @"Matt", @"Chris", @"Alex", @"Steve", @"Paul"];  
  2. NSDictionary *productManagers = @{@"iPhone": @"Kate", @"iPad": @"Kamal", @"Mobile Web": @"Bill"};  
  3. NSNumber *shouldUseLiterals = @YES;  
  4. NSNumber *buildingStreetNumber = @10018;  

不应该:

[cpp]  view plain copy
  1. NSArray *names = [NSArray arrayWithObjects:@"Brian", @"Matt", @"Chris", @"Alex", @"Steve", @"Paul", nil];  
  2. NSDictionary *productManagers = [NSDictionary dictionaryWithObjectsAndKeys: @"Kate", @"iPhone", @"Kamal", @"iPad", @"Bill", @"Mobile Web", nil];  
  3. NSNumber *shouldUseLiterals = [NSNumber numberWithBool:YES];  
  4. NSNumber *buildingStreetNumber = [NSNumber numberWithInteger:10018];  

常量

常量是容易重复被使用和无需通过查找和代替就能快速修改值。常量应该使用static来声明而不是使用#define,除非显式地使用宏。

应该:

[cpp]  view plain copy
  1. static NSString * const RWTAboutViewControllerCompanyName = @"RayWenderlich.com";  
  2. static CGFloat const RWTImageThumbnailHeight = 50.0;  

不应该:

[cpp]  view plain copy
  1. #define CompanyName @"RayWenderlich.com"  
  2. #define thumbnailHeight 2  

枚举类型

当使用enum时,推荐使用新的固定基本类型规格,因为它有更强的类型检查和代码补全。现在SDK有一个宏NS_ENUM()来帮助和鼓励你使用固定的基本类型。

例如:

[cpp]  view plain copy
  1. typedef NS_ENUM(NSInteger, RWTLeftMenuTopItemType) {  
  2.   RWTLeftMenuTopItemMain,  
  3.   RWTLeftMenuTopItemShows,  
  4.   RWTLeftMenuTopItemSchedule  
  5. };  

你也可以显式地赋值(展示旧的k-style常量定义):

[cpp]  view plain copy
  1. typedef NS_ENUM(NSInteger, RWTGlobalConstants) {  
  2.   RWTPinSizeMin = 1,  
  3.   RWTPinSizeMax = 5,  
  4.   RWTPinCountMin = 100,  
  5.   RWTPinCountMax = 500,  
  6. };  

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

不应该:

[cpp]  view plain copy
  1. enum GlobalConstants {  
  2.   kMaxPinSize = 5,  
  3.   kMaxPinCount = 500,  
  4. };  

Case语句

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

[cpp]  view plain copy
  1. switch (condition) {  
  2.   case 1:  
  3.     // ...  
  4.     break;  
  5.   case 2: {  
  6.     // ...  
  7.     // Multi-line example using braces  
  8.     break;  
  9.   }  
  10.   case 3:  
  11.     // ...  
  12.     break;  
  13.   default:   
  14.     // ...  
  15.     break;  
  16. }  

有很多次,当相同代码被多个cases使用时,一个fall-through应该被使用。一个fall-through就是在case最后移除'break'语句,这样就能够允许执行流程跳转到下一个case值。为了代码更加清晰,一个fall-through需要注释一下。

[cpp]  view plain copy
  1. switch (condition) {  
  2.   case 1:  
  3.     // ** fall-through! **  
  4.   case 2:  
  5.     // code executed for values 1 and 2  
  6.     break;  
  7.   default:   
  8.     // ...  
  9.     break;  
  10. }  

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

[cpp]  view plain copy
  1. RWTLeftMenuTopItemType menuType = RWTLeftMenuTopItemMain;  
  2. switch (menuType) {  
  3.   case RWTLeftMenuTopItemMain:  
  4.     // ...  
  5.     break;  
  6.   case RWTLeftMenuTopItemShows:  
  7.     // ...  
  8.     break;  
  9.   case RWTLeftMenuTopItemSchedule:  
  10.     // ...  
  11.     break;  
  12. }  

私有属性

私有属性应该在类的实现文件中的类扩展(匿名分类)中声明,命名分类(比如RWTPrivate或private)应该从不使用除非是扩展其他类。匿名分类应该通过使用<headerfile>+Private.h文件的命名规则暴露给测试。

例如:

[cpp]  view plain copy
  1. @interface RWTDetailViewController ()  
  2. @property (strong, nonatomic) GADBannerView *googleAdView;  
  3. @property (strong, nonatomic) ADBannerView *iAdView;  
  4. @property (strong, nonatomic) UIWebView *adXWebView;  
  5. @end 

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值