iOS编码规范

命名

小驼峰命名法：第一个单词小写字母开头，其他单词首字母大写；
大驼峰命名法：所有首字母大写；
注意：公司框架使用JM开头，在命名上避开JM。

1、文件命名
遵循大驼峰命名法，后面跟上对应的名称，不使用缩写。如新建一个ViewController，使用命名为：HomeViewController;

2、变量命名
类成员变量，属性，局部变量，使用小写开头的小驼峰法。变量名的名称尽量可以推测其用途，具有描述性。其中类成员变量在名称开头加一个下划线（NSString *_myInstanceVariable；）这种写法不要出现。

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

4、方法命名
方法名和方法参数遵循相同的规则，使用小写开头的小驼峰法；
方法名不允许使用“get“前缀。

注释

注释形式有“//”形式的单行注释 与“/* */”形式的多行注释这两种。
方法注释采用多行注释；（可以使用快捷键Command + Option + / ）
方法内注释采用行在上方的形式；
属性注释，使用单行注释，写在该属性后面；

项目管理

1、文件夹管理

框架目录

公司框架的目录结构如上图，APP的业务模块主要放在Module下。

APP业务模块

如上图例子，根据相应的业务模块划分创建文件夹，命名力求简短达意，末尾配上中文。

• 模块里面使用MVC的模式，必须有三个文件夹（Model、View、ViewController）

• 界面使用storyboard。storyboard的命名与外面的模块命名相同。
  storyboard中不进行页面跳转，只是页面静态布局。一个storyboard中最多放15个ViewController，超出则新建一个storyboard。
  storyboard中ViewController要使用中文标注，如下图

  
  storyboard
  

  因为框架的原因，storyboard中ViewController的唯一标识要与类名相同，如下图

  
  image.png
  使用到自定义cell，cell的重用identity和cell的类名要相同。

图片资源管理

使用Xcode自带Images.xcassets管理图片资源。
此处也根据模块创建文件夹，文件夹下面不再包含文件夹。图片命名不要包含中文，不要特殊字符、数字开头。

图片资源管理

代码组织

• storyboard的控件连线放在类的实现文件(.m文件)顶部，如下图

  
  image.png

• 使用initController、initData做初始化（框架中已经封装）

  
  image.png

• 使用#pragma mark -在ViewController中做区域划分，如下图所示，就有7个区域，这样能够快速定位
  UINavigation：导航栏的操作
  Actions：控件事件
  跳转：页面跳转
  网络：网络请求
  这些应该是每个ViewController都有的，可以借鉴。
  

  image.png