OC代码规范2.0

OC代码规范一、修改记录： (2)二、参考资料： (2)三、编码规范： (2)文件注释： (2)类的命名 (3)Protocals (3)方法命名及调用： (4)枚举的命名 (4)点用法： (5)空格： (5)bl ock： (5)条件语句 (6)三元运算子 (7)变量 (7)常量 (7)属性命名： (8)初始化和内存释放 (8)Literals字面量 (9)CGRect函数- 暂时不做限制 (9)BOOL陷阱 (10)异常处理： (11)调试Log (11)语言资源文件 (11)Additional： (11)OC代码规范一、修改记录：1，07-18初版by 黄超强2，版本：2.0 日期：07-223，修改记录：①增加相关规范：bl ock，异常处理，语言配置strings文件，调试l og打印②其他规范的补充以及修改：a，方法行数限制，方法注释b，枚举指明含义以及偏移c，条件语句if的格式规定d，switch的d efault条件处理e，初始化和内存释放f，CGRect暂不做限制g，实例变量前增加下划线二、参考资料：Appl e: Coding Guid elines for Cocoa, The Objective-C Programming LanguageGoogle: Objective-C Style Guid e三、编码规范：文件名命名规则：分类的文件名应该包含被扩展的类名，如：UIImageView+WebCache.h（目前Xcode 已自动生成）文件注释：Xcod e新建的文件默认有文件名，项目名称，创建者以及时间，版权信息，如：//// ViewController.h// Alpha1S_NewInteractionDesign//// Created by Jesse on 15/8/3.// Copyright (c) 2015年Ubtechinc. All rights reserved.//a.建议增加的内容：b.简单描述该文件主要实现的功能，作用等c.如果是修改别人的文件且有重大改动，建议在作者一栏增加修改记录，修改日期，修改人，后续维护有问题方便联系。

每行的长度▪每行最多不得超过100个字符▪Google的80字符的标准有点少，这导致过于频繁的换行（Objectve-C的代码一般都很长）通过“Xcod e => Preferences => TextEditing => 勾选Show Page Guide / 输入100 => OK” 来设置提醒类的命名类名（以及类别、协议名）应首字母大写，并以驼峰格式分割单词。

1.类的前缀1)所有类名、枚举、结构、protocol定义时最好加一个统一的标示符，可以是项目缩写，或者个人项目的名称缩写，例如都加上全大写的UBT作为前缀2)根据功能模块可以在给功能模块的类添加功能模块的名称前缀2.类的后缀所有protocol定义时，都加上后缀Delegate, 所有的控制器都加上Controller,所有的通知名都加上Notification。

Protocals▪类型标示符、代理名称、尖括号间不留空格。

▪该规则同样适用于：类声明、实例变量和方法声明。

▪如果类声明中包含多个protocal，每个protocal占用一行，缩进4个字符。

@public 和 @private使用单独一行,且缩进1个字符方法命名及调用：方法名应在 - OR + 和返回值之间留1个空格，方法名和第一个参数间不留空格，遵守小驼峰原则，首字母小写，其他单词首字母大写,每个空格分割的名称以动词开头。

执行性的方法应该以动词开头，小写字母开头，返回性的方法应该以返回的内容开头，但之前不要加get。

如：- (void)insertMod el:(id)mod el atInd ex:(NSUInteger)atInd ex;- (instancetype)arrayWithArray:(NSArray *)array;当参数过长时,每个参数占用一行,以冒号对齐。

如:- (void)d oSomethingWith:(GTMFoo *)theFoorect:(CGRect)theRectinterval:(CGFloat)theInterval {... }方法的注释要标明此方法的含义，各个参数的意义，返回值（VVDocumenter-Xcode插件）方法的调用调用方法沿用声明方法的习惯。

例外:如果给定源文件已经遵从某种习惯,继续遵从那种习惯。

所有参数应在同一行中,或者每个参数占用一行且使用冒号对齐。

如:[myObject d oFooWith:arg1 name:arg2 error:arg3];或[myObject d oFooWith:arg1name:arg2error:arg3];为保证视觉上的整洁和代码组织，在方法之间应提供且仅提供一行空白。

方法中的空白应用于区分功能，但空白行最好用于区分两个不同方法，调用方法的上边一行建议写明该方法的作用，这样就不用再点击对应的方法查看方法注释。

增加方法行数限制：单个方法最大行数为100行枚举的命名以Objective-C的方式命名枚举，因为它具备更强的类型检查和代码完成功能。

如：typed ef NS_ENUM(NSInteger, UIViewAnimationTransition) {UIViewAnimationTransitionNone,UIViewAnimationTransitionFlipFromLeft,UIViewAnimationTransitionFlipFromRight,UIViewAnimationTransitionCurlUp,UIViewAnimationTransitionCurlDown,};注：每个枚举对应的值、偏移需要写明，并且加上该枚举的注释。

点用法：点表示法应“仅”用于获取和改变属性。

括号表示法用于所有其它实例。

例如：恰当用法：view.backgroundCol or = [UIColor orangeColor];[UIApplication sharedApplication].delegate;不当用法：[view setBackgroundColor:[UICol or orangeCol or]];空格：（1）行缩进使用4个空格。

禁止使用Tab键来缩进。

请在Xcode偏好设置中进行设置。

（2）条件语句if的格式规定如下：if (fitsCondition) {//Do something} else {//Do something else}注：统一采用这种换行和对齐的方式block：bl ock换行：static dispatch_group_t http_request_operation_completion_group() {static dispatch_group_t af_http_request_operation_completion_group;static dispatch_once_t onceToken;dispatch_once(&onceToken, ^{af_http_request_operation_completion_group = dispatch_group_create();});return af_http_request_operation_completion_group;}bl ock使用之后要置空条件语句为避免错误，条件语句体必须使用大括号，即便语句体中的语句可以不必使用大括号（比如只有一行语句）。

常见的错误包括在不使用大括号的情况下添加第二行语句，以为它属于if语句的一部分。

此外，更可怕的事情是，如果条件语句中的代码行被注释，则本不术语条件语句的下一行代码将变成条件语句的一部分。

此外，这种编码风格和所有其它条件语句均保持一致。

例如：恰当用法：if (!error){return success;}不当用法：if (!error)return success;不当用法2：if (!error) return success;条件判断的时候，常量在前，变量在后，如if (CBCentralManagerStateUnsupported== _centralManager.state)避免出现魔鬼数字错误用法:switch(responseCod e){case 1:…break;case 2:…break:d efault:…break;}正确用法:switch(responseCod e){case CBCentralManagerStateUnsupported:…break;case CBCentralManagerStatePoweredOff:…break:d efault:…break;}建议使用有意义的枚举来代替魔鬼数字d efault条件的处理必须要写。

三元运算子仅当使用该运算子可以让代码显得更清晰易懂时方可使用三元运算子。

更多情况下应使用条件语句。

使用类似if的条件语句对多种条件进行判断通常要更容易理解，或使用实例变量。

恰当用法：result = a > b ? x : y;不当用法：result = a > b ? x = c > d ? c : d : y;变量变量的命名遵守小驼峰原则，应尽可能具有自解释性。

除非是常量，星号应紧贴变量名称表示指向变量的指针，比如：正确用法：NSString *text;不当用法：NSString* text; NSString * text;增加：实例变量前边要加下划线常量相对字符串字面量或数字，我们更推荐适用常量。

应使用static方式声明常量，而非使用#d efine的方式来定义宏。

此处说一下区别：宏：只是在预处理器里进行文本替换，没有类型，不做任何类型检查，编译器可以对相同的字符串进行优化。

只保存一份到.rodata 段。

甚至有相同后缀的字符串也可以优化，你可以用GCC 编译测试，"Hello world" 与"world" 两个字符串，只存储前面一个。

取的时候只需要给前面和中间的地址，如果是整形、浮点型会有多份拷贝，但这些数写在指令中。

占的只是代码段而已，大量用宏会导致二进制文件变大常量：共享一块内存空间，就算项目中N处用到，也不会分配N块内存空间，可以根据const 修饰的位置设定能否修改，在编译阶段会执行类型检查尽量使用const，看苹果api使用常量多点，比如UIKIT_EXTERN NSString *const UIApplicationDidEnterBackgroundNotification常量名称应将其中的所有单词的首字母大写，同时加上相关类的名称作为前缀。