Objective-C编程代码规范

前言

为了降低程序员之间的沟通成本，遵守代码规范显得尤为重要。当拿到别人的代码的时候，如果对方写的天花乱坠，你一定看的相当难受。调试起来也毫无头绪，所以养成代码规范的习惯应该从现在就做起。

---

命名

• 避免使用中文
• 避免使用拼音
• 遵循驼峰原则

---

注释

• 单行注释

//  note

• 多行注释

/*
    note
*/

• 文档注释

/**
 *  note
 */

• 注意：
  • 对于一行代码的注释可以放在前一行以及本行上
  • 不允许放在下一行
  • 更不允许放在一行语句的中间加入注释
  • 不必每行都加注释
  • 浅显易懂的代码不要加注释

---

排版

• 缩进
  • 使用空格(SPACE),不要用制表符(TAB)
  • 缩进的时候以两个空格为单位
• 空格
  • .h中协议<>前面有一个空格
  • .h中成员变量声明时，类型与变量之间只有有1个空格
  • *号靠近变量，不靠近类型
  • @property后留一个空格
  • ( )里面，逗号紧跟前一个变量，与后一变量之间留一个空格
  • ( )外面，先留一个空格，在声明属性
  • 方法的+, - 后面与（）之间留一个空格
  • 返回类型与 * 之间留一个空格
  • 方法参数中返回类型与* 之间留一个空格
  • 在多参数方法中，每个参数后面都有一个空格
• 空行
  • .h中的空行
    • 文件说明与头文件包含(#import)之间空1行
    • 头文件包含(#import)之间，如果需要分类区别，各类别之间空1行
    • 头文件包含(#import)与@class之间空2行
    • @interface与@class之间空1行
    • 头文件{}里面，空1行开始声明对象成员，如果需要分类区别，各类别之间空1行
    • 头文件{}外，空1行书写属性，如果需要分类区别，各类别之间空1行
    • 属性下面空1行开始写方法，如果需要分类区别，各类别之间空1行
    • 方法完成后，空1行@end
    • 如果需要声明protocol，空2行接着写。通常protocol写在@end后面，但是声明在@interface之前
  • .m中的空行
    • 文件说明与头文件包含(#import)之间空1行
    • 头文件包含(#import)之间，如果需要分类区别，各类别之间空1行
    • @implementation和@synthesize之间空1行, 如果需要分类区别，各类别之间空1行
    • @synthesize与方法之间空1行
    • 方法与方法之间空1行
  • 方法里面的空行
    • 变量声明后需要空1行，如果需要分类区别，各类别之间空1行
    • 条件、循环，选择语句，整个语句结束，需要空1行
    • 各功能快之间空1行
    • 最后一个括弧之前不空行
    • 注释与代码之间不空行
    • pragma mark 与方法之间空1行

---

命名规范

• 驼峰命名法
  • 用的最广的命名法，变量名常用此命名，命名由一个单词或多个单词组合而成，首字母小写其余单词首字母大写，如：“userName”
• 下划线命名法
  • 每个单词间使用下划线“_”分割，所有字母均小写，如：“user_name”
• 帕斯卡命名法
  • 每个单词的首字母均大写的一串字符，与“骆驼命名法”的区别在于前者的首字母大写，后者的首字母小写。如：“UserName”
• 注意：
  • 变量名尽量不要使用缩写，如我们经常可以看到很多开发者习惯于把根视图控制器写成rootVC或者mainVC等等，而系统给我们提供的却是完整的命名：self.window.rootViewController，假如系统给我们提供的是self.window.rootVC这种形式，以及其他命名方式也这样以非专业词汇的缩写命名，相信很多开发者会看的一头雾水

---

协议的签订格式

• 协议的签订推荐使用以下格式，优点是签订的协议一目了然
• 添加的注释也看着比较舒服

---

每一行的最大长度

• 在 Xcode > Preferences > Text Editing > Page guide at column:
• 将最大行长设置为 80 ，过长的一行代码将会导致可读性问题。

---

函数的格式

一个典型的 Objective-C 函数应该是这样的

• 在 - 和 (void)之间应该有一个空格
• 第一个大括号{的位置在函数所在行的末尾，同样应该有一个空格

---

如果一个函数有特别多的参数或者名称很长，应该将其按照 : 来对齐分行显示：

---

语法糖

应该使用可读性更好的语法糖来构造 NSArray ， NSDictionary 等数据结构，避免使用冗长的 alloc,init 方法。

如果构造代码写在一行，需要在括号两端留有一个空格，使得被构造的元素于与构造语法区分开来：

---

构造字典时，字典的 Key 和 Value 与中间的冒号 : 都要留有一个空格，多行书写时，也可以将 Value 对齐：

---

编码风格

• 不要使用new方法

  • 尽管很多时候能用 new 代替 alloc init 方法，但这可能会导致调试内存时出现不可预料的问题。 Cocoa 的规范就是使用 alloc init 方法，使用 new 会让一些读者困惑。

• Public API 要尽量简洁

  • 公有接口要设计的简洁，满足核心的功能需求就可以了。不要设计很少会被用到，但是参数极其复杂的 API 。如果要定义复杂的方法，使用类别或者类扩展。

• import 和 include

  • 当引用的是一个 Objective-C 或者 Objective-C++ 的头文件时，使用 #import
  • 当引用的是一个 C 或者 C++ 的头文件时，使用 #include ，这时必须要保证被引用的文件提供了保护域（ #define guard ）

---

最后

代码规范是程序员从始至终都需要关心的问题，需要时间去不断积累，细节决定成败。此文长期更新。