iOS开发之OC命名规范和编码规范(持续更新)

坚持 成长 每日一篇

命名规范

苹果公司自身框架使用的驼峰命名法，为了保持统一我们也是用驼峰命名法

小驼峰命名法(CamelCase)：第一个单词小写字母开头，其他单词首字母大写；
大驼峰命名法(PascalCase): 所有首字母大写。

禁止使用 _ 分割单词，为了保持和系统命名使用方法一致

1. 类名，协议名，使用大驼峰命名
2. 常量：这里的常量指的是宏(#define)、枚举(enum)、常量(const)等，使用小写”k“作为前缀，名称遵循大驼峰命名法

3. 方法

   • 方法名和方法参数遵循相同的规则，使用小写开头的小驼峰法；
   • 方法名和参数尽量读起来像是一句话；
   • 方法名不允许使用“get“前缀；
   • -或+与返回类型间留一个空格，但参数列表之间不要留间隔；
   • 如果参数过多，推荐每个参数各占一行；
     例如：
     

     [person setName:@""
                 age:1
           eyesColor:[UIColor redColor]];

4. 变量：

   • 类成员变量，属性，局部变量，使用小写开头的小驼峰法，
   • 类成员变量在名称开头加一个下划线，比如:_myLovalVariable, _myInstanceVariable
   • 变量名的名称尽量可以推测其用途，具有描述性。

编码规范

• 方法的名字不宜过长，原则上是不超过100行
• 类的实现文件内容不宜超过1000行,最好500行以内
• 类的头文件不要引入其他自定义头文件（允许系统文件），用@class引入需要声明的类，在实现文件里引入你需要的头文件
• 视图类里面不要引用控制器对象，如果需要与控制器对象通信，请使用协议
• 注释规范，类的头文件和实现文件都要根据公司要求注释好作者，时间，类的主要功能，以及保留类重大更新日志。对于小的改动在改动处要注明：姓名，改动原因或者Bug链接等
• 如果m文件中有较多的method，使用#pragma mark - 标记对方法进行分组，便于查看；
• 尽量多使用协议，通知，KVO，代码块回调来降低类与类之间的耦合度
• MVC规范里M层不能有对C层，V层的类的引用，V层类不能有对C层盒，M层类的引用
• 局部基本数据类型的变量要初始化，不然会发生一些不可预知的错误，如Bool有时候不初始化，YES和NO都有可能。int不初始化有可能是非0值