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问题。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,271评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,275评论 2 380
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,151评论 0 336
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,550评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,553评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,559评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,924评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,580评论 0 257
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,826评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,578评论 2 320
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,661评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,363评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,940评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,926评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,156评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,872评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,391评论 2 342

推荐阅读更多精彩内容