Objective-C 编码规范

1.变量与函数命名

1.1变量命名

对于变量或属性的命名,首先要统一使用US英语,不要使用汉语拼音代替,命名应简洁清晰。

统一使用US英语

正确:

UIColor *myColor = [UIColor whiteColor];

错误:

UIColor *myColour = [UIColor whiteColor];

命名拼写不规范

UIColor *naem = @"隔壁老王";

使用汉语拼音

UIView *qiangmaiButton;

1.2方法命名

对于方法的命名,首先应遵守Objective-C的命名风格,在风格上保持统一

1.方法功能清晰,从左至右读起来要像日常用语的句子,做到初中生都能读懂的程度,让别的开发一眼看出要做的事
2.参数名清晰,不要使用缩写,避免理解上的晦涩
3.与Foundation/CoreFoundation等框架保持一致,避免命名上的冲突,可以参考下这些框架的命名风格

举个病栗:

-(void)showTheLoveWithUID:(NSString *)UID ColorNumberStr:(NSString *)colorNumberStr

该方法有以下几个问题:

1.外部参数名不要大写开始
2.方法功能不清晰,读起来不易明白,改为:showTheLoveWithUID:andColorNumber
3.外部参数名要清晰,同时要保证函数名语意上的连贯,而内部参数名要简洁

改正后:

-(void)showLoveWithUID:(NSString *)UID andColorNumber:(NSString *)colorStr

1.3枚举类型

枚举类型使用如下方式定义:

typedef NS_ENUM(NSInteger, ZXGender) {
    ZXGenderUnknown = -1,
    ZXGenderFemale,
    ZXGenderMale,
};

有几点需要注意:
1.对于枚举,一般都是有符号数,使用NSInteger
2.枚举值默认从0开始,尽量指定枚举从None,Invalid的值开始,该值显式初始化为-1,这样可以避免一些地方默认值导致的问题

1.4可选型

typedef NS_ENUM(NSUInteger, ZXUserStateType) {
    ZXUserStateTypeSystem = 1<<0, // 系统帐号
    ZXUserStateTypeRobot = 1<<1, // 机器人帐号
    ZXUserStateTypeManager = 1<<2, // 管理员
};

可选型区别在于每一位都可以表示一种情况,所以需要定义为无符号数
尽量不要使用如下形式:

typedef enum: MyEnumType {
    MyEnumType1,
    MyEnumType2,
};

2.使用#pragma mark - 对方法进行分类

#pragma mark - Override //重写方法

- (void)dealloc {} 

- (instancetype)init {}   

- (void)viewDidLoad {}

- (void)viewWillAppear:(BOOL)animated {}  

- (void)didReceiveMemoryWarning {} 

#pragma mark - Public //公有方法 

- (void)publicMethod {} 

#pragma mark - Responder //响应事件的方法,包括处理通知的方法

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

- (void)handleNotification:(NSNotification *)notification {}

#pragma mark - Delegate //代理实现方法(以相应协议名命名,点击该协议名可以跳转到协议声明的地方)

#pragma mark - Private //私有方法
#pragma mark UI Related Private Methods
- (void)initUI {} 

#pragma mark Transaction Related Private Methods
- (void)isNetworkReachable {} 

#pragma mark - Setter //Setter方法

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

#pragma mark - Getter //Getter方法,通常实现懒加载  

- (id)customProperty {}

.m文件中代码的组织有以下几点注意:

1.Ovverride 方法都是覆写的方法,属于生命周期的重要实现,放在最上面,方便查看,dealloc放在最上面,因为dealloc在功能和阅读上作用不大,主要用来做释放检查
2.Public方法次之,这是些头文件里面公开出去的接口,放在上面比较醒目些
3.Delegate方法是一些和外部类通信的协议实现,也属于较重要的逻辑实现
4.Private Method包括一些Helper方法都是类中内部使用的方法,相对而言,逻辑上的重要性较次,放在后面
5.Getter & Setter方法放在最后,都是功能比较单一的方法,基本没有复杂逻辑
6.#pragma mark - 与 #pragma mark 要正确的配合使用
总之一句话,逻辑上越重要的,位置越靠上,尽量保证在滑动两屏的情况下能找到这些重要的函数

有些需要注意的地方:

1.不要使用#pragma mark 来注释,如果方法需要注释,就在方法上方使用//注释内容
2.不要使用中文,也没必要使用中文来添加#pragma mark 

3.一些需要注意的点

3.1属性声明

比如一个班级学生的成绩单:

@interface ClassStudentTranscript : NSObject
@property (nonatomic, stong) NSString *class;
@property (nonatomic, strong) NSNumber *studentCount;
@property (nonatomic, copy) NSMutableArray *studentList;
@end

1.class和studentCount不会改变,使用strong的话,可能强引用的对象在别的地方被修改,这样的错误很难排查
2.对于用copy属性声明,这样在调用setStudentList方法时,传进来的对象会被copy一份(不管是浅拷贝还是深拷贝),这样得到的对象就是一个不可变对象,再对该属性进行增删操作时,就会出现unrecognized method 错误

政治不正确的写法:

@property (strong, atomic) NSString *property1;

3.2 block的使用

@interface InteractiveStudioView () {
NSString *_address;
}
@property (nonatomic, copy) NSString *name;
@end

dispatch_async(dispatch_get_main_queue(), ^{
    self.name = @"隔壁黄总";
});

dispatch_async(dispatch_get_main_queue(), ^{
    _address = @"上海盛夏路500号绿岸科创园6F";
});

block在使用时注意引用强引用问题,对于一个属性self.name 和_address的使用,都会强引用当前self对象。

3.3 if...else 的风格问题

有以下几种风格:

风格1:
if (success) {  
    //Do something  
} else {  
    //Do something else  
}

风格2:
if(success){  
    //Do something  
}else{  
    //Do something else  
}
风格3:
if (success) {  
    //Do something  
} 
else {  
    //Do something else  
}

首先毙掉风格2,注意空格;
风格3的好处:在注释时不会导致if 语句断掉,在别的语言里,这也是推荐的风格,很奇怪,Objective-C推荐的居然是风格1,我个人偏向使用风格3的换行方式。

3.4 字面常量(literal)的使用问题

生命一个不可变string或number类型时,尽量使用字面常量的写法:

NSString *question = @"为啥隔壁王叔叔和大头儿子一样头很大";
NSNumber *age = @(15); 

3.5 注意NS开头的对象初始化方法传值

对于NS开头的对象,如果初始化时传入nil指针,很可能导致crash的发生,在做相关初始化操作时,先检查参数是否合法,这样可以避免很多crash问题。

你可能感兴趣的:(Objective-C 编码规范)