iOS开发规范（Objective-C）

1.代码组织

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
#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 {}

2.大括号

方法大括号和其他大括号(if/else/switch/while 等.)总是在同一行语句打开但在新行中关闭。

1
2
3
4
5
6
7
8
9
10
11
12
比如：if (user.isHappy) {  
//Do something  
} else {  
//Do something else  
}  
而不是：if (user.isHappy)  
{  
//Do something  
}  
else {  
//Do something else  
}

个人喜欢调用方法时使用冒号对齐的方式。例如：

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

3.命名

长的，描述性的方法和变量命名是好的。
UIButton *settingsButton;
而不是
UIButton *setBut;
三个字符前缀应该经常用在类和常量命名
常量应该使用驼峰式命名规则，所有的单词首字母大写和加上与类名有关的前缀。如：
static NSTimeInterval const RWTTutorialViewControllerNavigationFadeAnimationDuration = 0.3;
属性也是使用驼峰式，但首单词的首字母小写。

4.下划线

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

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

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

5.方法

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

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

1
2
3
4
- (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;

而不是

1
2
3
4
5
-(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.

6.变量

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

星号表示变量是指针。例如， NSString *text 既不是 NSString* text 也不是 NSString * text，除了一些特殊情况下常量。
私有变量应该尽可能代替实例变量的使用。尽管使用实例变量是一种有效的方式，但更偏向于使用属性来保持代码一致性。
通过使用’back’属性(_variable，变量名前面有下划线)直接访问实例变量应该尽量避免，除了在初始化方法(init, initWithCoder:, 等…)，dealloc 方法和自定义的setters和getters。

1
2
3
@interface RWTTutorial : NSObject  
@property (strong, nonatomic) NSString *tutorialName;  
@end

而不是

1
2
3
@interface RWTTutorial : NSObject {  
NSString *tutorialName;  
}

7.属性特性

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

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

而不是

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

8.字面值

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

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

而不是

1
2
3
4
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];

9.常量

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

1
2
static NSString * const RWTAboutViewControllerCompanyName = @"RayWenderlich.com";  
static CGFloat const RWTImageThumbnailHeight = 50.0;

而不是

1
2
#define CompanyName @"RayWenderlich.com"  
#define thumbnailHeight 2

10.枚举类型

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

1
2
3
4
5
typedef NS_ENUM(NSInteger, RWTLeftMenuTopItemType) {  
RWTLeftMenuTopItemMain,  
RWTLeftMenuTopItemShows,  
RWTLeftMenuTopItemSchedule  
};

而不是

1
2
3
4
enum GlobalConstants {  
kMaxPinSize = 5,  
kMaxPinCount = 500,  
};

11.Case语句

大括号在case语句中并不是必须的，除非编译器强制要求。当一个case语句包含多行代码时，大括号应该加上。
有很多次，当相同代码被多个cases使用时，一个fall-through应该被使用。一个fall-through就是在case最后移除’break‘语句，这样就能够允许执行流程跳转到下一个case值。为了代码更加清晰，一个fall-through需要注释一下。

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

当在switch使用枚举类型时，’default’是不需要的。例如：

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

12.私有属性

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

1
2
3
4
5
@interface RWTDetailViewController ()  
@property (strong, nonatomic) GADBannerView *googleAdView;  
@property (strong, nonatomic) ADBannerView *iAdView;  
@property (strong, nonatomic) UIWebView *adXWebView;  
@end

13.布尔值

Objective-C使用YES和NO。因为true和false应该只在CoreFoundation，C或C++代码使用。既然nil解析成NO，所以没有必要在条件语句比较。不要拿某样东西直接与YES比较，因为YES被定义为1和一个BOOL能被设置为8位。
这是为了在不同文件保持一致性和在视觉上更加简洁而考虑。

1
2
3
4
if (someObject) {}  
if (![anotherObject boolValue]) {} 
``` 
而不是

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

1
如果BOOL属性的名字是一个形容词，属性就能忽略"is"前缀，但要指定get访问器的惯用名称。例如：

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

1
2
### 14.条件语句
件语句主体为了防止出错应该使用大括号包围，即使条件语句主体能够不用大括号编写(如，只用一行代码)。

if (!error) {
return success;
}

1
而不是

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

1
2
### 15.Init方法
Init方法应该遵循Apple生成代码模板的命名规则，返回类型应该使用`instancetype`而不是`id`。

  • (instancetype)init {
    self = [super init];
    if (self) {
    // …
    }
    return self;
    } 
    1
    2
    ### 16.类构造方法
    当类构造方法被使用时，它应该返回类型是`instancetype`而不是`id`。这样确保编译器正确地推断结果类型。

@interface Airplane

  • (instancetype)airplaneWithType:(RWTAirplaneType)type;
    @end
    ```

    17.Xcode工程

    物理文件应该与Xcode工程文件保持同步来避免文件扩张。任何Xcode分组的创建应该在文件系统的文件体现。代码不仅是根据类型来分组，而且还可以根据功能来分组，这样代码更加清晰。

尽可能在target的Build Settings打开”Treat Warnings as Errors，和启用以下additional warnings。如果你需要忽略特殊的警告，使用Clang’s pragma feature。

xcode创建项目时需填好organization name和organization identify

以后在项目中创建类时要给自己创建的类加个前缀，一来防止类名重复，二来多人协作时一看就知道哪些类是自己写的，将来好填坑。比如我创建的类是CL为前缀，如：CLPerson。

最后：在开发项目时使用MVC或者MVVM模式

赏

谢谢你请我吃糖果

支付宝
微信

扫一扫，分享到微信

微信分享二维码

tag:

    缺失模块。
    1、请确保node版本大于6.2
    2、在博客根目录（注意不是yilia根目录）执行以下命令：
    npm i hexo-generator-json-content --save

    3、在根目录_config.yml里添加配置： 

      jsonContent:
    meta: false
    pages: false
    posts:
      title: true
      date: true
      path: true
      text: false
      raw: false
      content: false
      slug: false
      updated: false
      comments: false
      link: false
      permalink: false
      excerpt: false
      categories: false
      tags: true

不断超越自己