参考Coding Guidelines for Cocoa/Cocoa编码指南
1)命名
1.1)类，函数，命名空间，协议采用大驼峰法，例如@interface FCLoginViewController。
1.2)变量，方法及方法参数，属性采用小驼峰法，例如NSInteger myUserName，方法名不允许使用”get”前缀。
1.3)常量，大驼峰法命名，加前缀，宏(#define)、枚举(enum)、常量(const)等，局部常量使用小写”k”作为前缀，定义类头文件中的常量，外部可见，则通常以定义该常量所在类的类名开头，整型尽量用枚举，使用 const 定义浮点型或者单个的整数型常量。
1.4)通知,[ 触发通知的类名 ] + [Did | Will] + [ 动作 ] + Notification
1.5)Delegate,类名+Delegate,数据源类名+DataSource
1.6)协议，协议名+ing
1.7)可以在类，协议，函数，常量以及typedef宏定义的时候使用前缀，不用为成员变量及方法使用前缀。
2)头文件引用
2.1)当引用的是一个Objective-C或者Objective-C++的头文件时，使用#import
2.2)引用的是一个C或者C++的头文件时，使用#include，这时必须保证被引用的文件提供了保护域(#define guard)，以保证代码在不同平台间共享时不出现问题。
2.3)引用与框架同名的头文件，而不是其它子模块的头文件。
2.4)尽量避免在pch中引用头文件，引用过多造成编译速度变慢。
3)格式化代码
3.1)类方法声明在方法类型与返回类型之间要有空格
3.2)条件判断的括号内侧不应有空格
3.3)关系运算符两边要有空格
3.4)方法的花括号推荐另起一行，方法内部需要写在一行，另起一行在代码拆叠后非常难看。
3.5)方法内部尽可能早的返回错误
3.6)方法调用写一行，多行写按照”:”对齐
3.7)使用可读性更好的语法糖来构造NSArray，NSDictionary等数据结构，避免使用冗长的alloc,init方法,如果构造代码写在一行，需要在括号两端留有一个空格，使得被构造的元素于与构造语法区分开来。
3.8)类属性定义@property与括号之间应有空格。
3.9)对于指针类型的变量，将指针放在变量前且无空格。
3.10)方法最左边的(+,-)和返回类型的左括号之间有一个空格，返回类型的右括号与第一参数之间没有空格。
4)注释
4.1)方法注释参数的意义，返回值，功能及可能的副作用。
4.2)协议，委托的注释要明确说明其被触发的条件
4.3)定义在头文件里的接口方法，属性必须要有注释。
4.4)如果在注释中要引用参数名或者方法函数名，可使用“||”将参数或方法括起来以避免歧义。
5)类型
5.1)写delegate的时候类型应该为weak弱引用，避免循环引用以及assign，Strong造成的释放问题，当delegate不存在时自然要销毁。
5.2)NSString类型变量用copy修饰比较安全。
6)编码风格
6.1)初始化时不要使用new方法，尽量使用alloc init方法，使用new可能导致调试内存时出现不可预料的问题。
6.2)在init和dealloc中不要用存取方法方问实例变量。
6.3)枚举定义显式地typedef NS_ENUM(类型，变量名)。
6.4)NSLog提交尽可能的删除，最好能找个Log工具。
6.5)Core Foundation 对象created,retain均须做CFRelease处理。
7)文件组织结构
7.1)by层次分
7.2)by功能分
8)nil检查,传入参数做保护处理
9.1)NSMutableDictionary->key&NSMutableArray不能插入nil
9.2)NSAttributedString
9.3) NSJSONSerialization,JSONObjectWithData
9.4) @{key:value},value不能为nil
9.5)strtoul([colorString UTF8String], colorString不能为nil
9.6) CFRelease传入值不能为nil
9)ViewController
#pragma mark- Lifecycle
- (instancetype)init {}
- (void)dealloc {}
- (void)viewDidLoad {}
- (void)viewWillAppear:(BOOL)animated {}
- (void)didReceiveMemoryWarning {}
#pragma mark- Custom Accessors
- (void)setXXXProperty:(id)value {}
- (id)XXXProperty {}
#pragma mark- IBActions/Event Response
- (IBAction)submitData:(id)sender {}
- (void)someButtonDidPressed:(UIButton*)button
#pragma mark- Protocol conformance
#pragma mark- UITextFieldDelegate
#pragma mark- Public
- (void)publicMethod {}
#pragma mark- Private
- (void)privateMethod {}
#pragma mark- NSCopying
- (id)copyWithZone:(NSZone*)zone {}
#pragma mark- NSObject
- (NSString*)description {}
10)证书管理
10.1)APNS证书失效后可重新生成并在线替换。
10.2)企业版证书在失效前必须用新证书重新打包，证书失效会造成APP无法启动。
10.3)微信支付等第三方支付可能引起审核不通过，尽量采用苹果自带IAP。
10.4)plist中Application supports iTunes file sharing必须关闭，否则审核不通过。
10.5)应用内涉及到抽奖的运营活动，须声明与苹果官方无关。
10.6)使用了AdSupport.framework获取IDFA，须在AppStore勾选广告标识符。
网友评论