编码规范

制定编码规范的原因是我们在开发和维护时候可以保持代码风格一致,在一个项目的生命周期中,可能会有不同的人参与到开发和维护,保证了风格一致的编码规范无疑会规避很多的风险,让项目始终保持在一个合理和健康的状态。

1.代码组织
代码实现中以 #Pragram mark - 来分类方法,遵循以下结构、顺序

#pragram mark - Life Cycle
#pragram mark - Private Methods
#pragram mark - Public Methods
#pragram mark - Event Response
#pragram mark - UITableView Datasource
#pragram mark - UITableView Delegate
#pragram mark - Custom Accessors

2.空格
tab或4个space,保持统一

3.方法和条件判断语句的大括号,总在同一行语句打开,并在新行关闭
应该

if (user.isHappy) {  
    //Do something  
} else {  
    //Do something else  
}  

不应该

if (user.isHappy)  
{  
    //Do something  
}  
else {  
    //Do something else  
}  

方法之间应该有且只有一行,这样有利于视觉上更清晰和更易于组织。方法内的空白应该分离功能,但通常都抽离出来一个新的方法

4.注释
当需要注释时候,注释应该用来解释这段特殊代码为什么这么做
一般都避免是用注释,因为代码尽可能做到自注释

5.命名
规则尽可能坚持长的,描述性的命名。
应该:

UIButton *settingsButton;  

不应该:

UIButton *setBut;  

常量命名应该使用小写字母k(k代表const)作为前缀,同时使用驼峰式命名规则
应该:

static NSTimeInterval const kTutorialViewControllerNavigationFadeAnimationDuration = 0.3;  

不应该:

static NSTimeInterval const fadetime = 1.7;  

类名使用驼峰式命名,首字母大写
属性使用驼峰式命名,首字母小写
方法名使用驼峰式命名,首字母小写

6.下划线
当使用属性的时候应该使用self.来访问和改变,这就意味着属性和实例变量视觉效果上不同,因为它们前边都有self.
但是在初始化方法和和getter/setter中应该使用下划线来避免潜在的副作用
局部变量不应该存在下划线

7.方法
在方法签名中,(-/+)后应该存在一个 空格,这符合Apple的风格,在参数之前包含一个具有描述性的关键字来描述参数。“and”这个词的用法应该保留,它不应该用于表示具有多个参数

应该:

- (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;  

不应该:

- (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.  

8.变量
尽量以描述性的方式来命名,避免出现单个字符的变量命名,除了在for()循环中
*代表的是指针,格式应该是NSString *text, 不应该是 NSString * text 和 NSString* text
基本类型使用NSInteger 代替int
基本类型使用CGFloat代替float

9.属性特性
NSString, NSArray, NSDictionary应该使用copy而不是strong的属性特性
delegate应该使用weak属性
block使用strong属性

10.NSString, NSDictionary, NSArray 和NSNumber在初始化时候应当尽量使用字面值。注意nil不能传入NSArray和NSDictionary,这样会导致crash

应该:

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

不应该:

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];  

11.常量
使用常量可以通过查找和替代来快速修改值,常量尽可能使用static来代替#define

static NSString * const kAboutViewControllerCompanyName = @“www.apple.com";  
static CGFloat const kImageThumbnailHeight = 50.0;  

不应该:

#define CompanyName @“www.apple.com"  
#define thumbnailHeight 2  

12.枚举类型

使用NS_ENUM() 代替 enum(),因为它有更强的类型检查和代码补全

13.init方法使用instancetype作为返回值

应该:

- (instancetype)init{   
    return [self initWithBaseURL:[NSURL URLWithString:BASE_URL]];   
}

不应该:

- (id)init{
    return [self initWithBaseURL:[NSURL URLWithString:BASE_URL]];   
}

14.条件判断
if语句为了提高可读性避免出错,应该总是用大括号包围,即使只有一样代码
应该:

if(!error){
     return success;
}

不应该:

if(!error)
     return success;

或:

if(!error)  return success;

同时条件判断语句应该使用黄金路径,左手边的代码应该是“golden”和“happy”的,也就是不要嵌套if语句,多个返回语句也是可以的
应该:

- (void)someMethod{
     if(!success){
          return;
     }
     // Do something important
}

不应该:

- (void)someMethod{
     if(success){
     // Do something important
     }
}

待续...

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

推荐阅读更多精彩内容