Swift代码规范

1. 间隔缩进

   讲tab键转换成对应4个的空格。

   打开Xcode->Preference->TextEditing->Indentation->Tab with 4 spaces/indent width 4 spaces

2. 文件命名

   首字母需大写，之后每个单词首字母都需大写。

   名词短语并且能够反映类的功能。例如：LoginViewController.swift

3. 特殊文件命名

   如果文件是视图控制器的子类，应添加后缀“ViewController“或者”Controller“

   如果是视图的子类应添加后缀”View“

   如果是按钮的子类应添加后缀”Button“。依此类推例如：LoginViewController.swift，UserInfoView.swif

4. 类命名

   和文件命名原则相同

5. 分类（类别）命名

   与类命名相同，此外需添加要扩展的类名和“+”。例如：NSString+Base64

6. 协议（委托）命名

   与类命名相同，此外需添加“Delegate”后缀。例如：PalyViewDelegate

7. 方法命名

   首字母小写，之后每个单词首字母都大写，见名知其意，例如：func setUserName（value：String）

8. 方法参数命名

   首字母小写，之后每个单词都字母都大写，名词具有足够的说明性。例如：func sendUserInfo（userInfo：NSDictionary）

9. 变量命名

   首字母小写，之后每个单词首字母都大写，名称具有足够的说明性。

   成员变量添加“_”前缀，而不需要添加“_m”

10. 常量

    常量（预定义，局部常量等）使用小写k开头的驼峰法，例如：kRightViewX，kDuration

11. 枚举类型

    命名首字母大写，之后每个单词首字母都大写，枚举变量的每个单词首字母大写。例如：

    enum MapDirection1{

    case North,South,East,West

    }

12. 图片命名

    使用英文，首字母大写，之后每个单词首字母都大写。

    添加模块名作为前缀，避免冲突。

    图片应该与类文件一样，按模块分组放置。

13. 分组命名

    使用英文，首字母大写，之后每个单词首字母都大写。

    每个分组使用模块的名字。

    使用的公共组件统一放在“Common”分组下。

    使用的开源库统一放在“Library”分组下。

    视图控制器及AppDelegate统一放在“Controllers”分组下。

14. 注释

    文件都包含头文件，要说明文件名、作者、创建时间、变更记录。

    多人协作完成项目时，public接口的每个方法都应该添加关于函数、参数、返回值以及副作用的注释。

    当if语句的判断条件复杂时，需要用注释说明判断内容。

    接口类（继承于BaseClient）的头文件每个方法前都应该注明方法的作用。

15. 其他规范

    避免相同的代码段在多个地方出现。

    语句嵌套层次不得超过3层。

    每个实现文件建议在500行以内，不能超过1000行，超过之后应考虑通过抽象类对代码进行重构。

    确定不使用的代码应该删除。

    控件布局使用相对坐标。