iOS代码规范 2016版

达内纪老师 2016年1月1日
微信公众号:iOS_yingxin 名称:小新的iOS之旅
我的: GitHub CSDN博客

代码规范基本上都是从苹果原生示例代码中总结出来的, 大家可以多查看苹果示例代码进行学习.

驼峰命名法

OC提倡自注释命名方式,即通过多个单词组合成一个有含义的类名,变量名或者方法名.为了方便区分单词,采用单词首字母大写的方式.* 类名所有单词首字母都要大写* 变量名第一个单词首字母小写* 方法名采用动宾结构,也就是'动词'+'名词'的形式;第一个单词首字母小写例如:用户信息类:  @interface UserInfo: NSObject{    //用户名变量    NSString *_userName    //用户学生编号    int _userStudentCount;} //创建用户名方法: - (void)createUserName;@end

空格的使用方式

声明变量时,指针符号*与变量名无间隔,与类名有一个空格间隔

形式上是 类名 *变量名- NSString *user = @"";- NSArray *userList = @"";

使用,, ;时, 与前方单词无间隔,后面加一个空格

形式上是'单词, '- @interface UserInfo: NSObject{} @end- @[@"11", @"22", @"33", @"44"];- @{@"userName": @"美玲", @"sex": @"女", @"age": @22};- NSLog(@"%@", userList);- for(int i = 0; i < 9; i++){}

三目运算符

条件语句 ? 真值 : 假值;NSString *category = age <= 18 ? @"小孩" : @"成年人";为变量做非空处理NSString *aStr = nil;aStr = aStr ?: @"";代码作用是判断aStr是否为nil如果是nil,那么赋值为@""; 否则什么都不做

运算符=, ==, +, -, *, /, %, +=, -=, *=, /=, %=前后加空格

* a += 4;* int c = b + 2;* NSString *name = @"美玲";* if(i == 5){}

自增自减

i++; i--; --i; ++i;  变量和运算符之间无空格for(int i = 0; i < 9; i++){}

方法的声明

对象方法或者类方法的+, - 号后面加空格

- (void)createUser;+ (id)userWithType;

单例方法

通常以'standard', 'default', 'main', 'shared', 'current'单词开头+ (UIApplication *)sharedApplication+ (UIScreen *)mainScreen; + (UIDevice *)currentDevice;+ (NSUserDefaults *)standardUserDefaults;+ (NSFileManager *)defaultManager;  

类工厂方法

通常以类名开头+ (instancetype)buttonWithType:(UIButtonType)buttonType;+ (instancetype)stringWithString:(NSString *)string;

关系词

'At', 'From', 'To', 'With', 'By'- (unichar)characterAtIndex:(NSUInteger)index;- (NSString *)substringFromIndex:(NSUInteger)from;- (NSString *)substringToIndex:(NSUInteger)to;- (NSString *)substringWithRange:(NSRange)range;- (NSString *)stringByAppendingString:(NSString *)aString;

多参数方法, 除第一个参数,其他参数名通常不带有关系词

- (NSRange)rangeOfString:(NSString *)searchString                  options:(NSStringCompareOptions)mask                    range:(NSRange)searchRange;

属性的声明

@property后面加空格@property (nonatomic, readonly) UITableViewStyle style;

常量的定义

代码中尽量不要出现字符串或者数字, 因为后期维护时不方便.习惯上通过把字符串, 数字声明为常量, 做到常量的统一管理.常量定义的方式有以下两种:#define 宏定义static const 静态常量不管声明哪种类型的常量,变量名都需要添加'k'开头,这样可以有效防止命名冲突问题具体使用时:声明对象类型的常量时, 习惯使用:static NSString *const kCellIdentify = @"CellName";声明基础类型常量时, 习惯使用:#define kDuration 30

代码分段#pragma mark -

在代码中通常使用'#pragma mark - '来对代码进行分段,方便后期维护.例如@implementation ViewController#pragma 懒加载- (UITableView *)someTable{return nil;}- (UIButton *)someBtn{return nil;}#pragma mark - UITableViewDataSource 表格数据- (NSInteger)tableView:(UITableView *)tableView numberOfRowsInSection:(NSInteger)section{return 0;}- (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath{return nil;}#pragma mark - UITableViewDelegate 表格代理- (void)tableView:(UITableView *)tableView didSelectRowAtIndexPath:(NSIndexPath *)indexPath{}#pragma mark - 生命周期- (void)viewDidLoad {    [super viewDidLoad];    // Do any additional setup after loading the view, typically from a nib.}- (void)viewWillAppear:(BOOL)animated{    [super viewWillAppear:animated];}- (void)viewWillDisappear:(BOOL)animated{    [super viewWillDisappear:animated];}- (void)didReceiveMemoryWarning {    [super didReceiveMemoryWarning];    // Dispose of any resources that can be recreated.}@end

成员变量的声明

成员变量要使用'_'进行标示@interface UserInfo: NSObject{    NSString *_userName; //成员变量添加下划线_}@end

协议的使用

协议的声明要跟’#import’关键词之间隔一行以上,否则没有代码提示

#import <UIKit/UIKit.h> @protocol ViewControllerDelegate <NSObject>@end@interface ViewController : UIViewController@property (nonatomic, weak) id<UITableViewDelegate> delegate;@end

协议变量要使用weak修饰

@property (nonatomic, weak) id<UITableViewDelegate> delegate;

构造方法的返回值选择instancetype

- (instancetype)init- (instancetype)initWithCoder:(NSCoder *)aDecoder+ (instancetype)string;+ (instancetype)stringWithString:(NSString *)string;