iOS端应用开发规范-命名约定

一.版本号命名

采用A.B.C 三位数字命名，比如：2.0.3，当有版本更新的时候，依据下面的情况来确定版本号规范

| 版本号 | 说明 | 举例 |
|:------------- |:-------------:|----- :|
|A.b.c |属于重大更新内容| 2.0.3 -> 3.0.0
|a.B.c |属于小部分更新内容| 2.0.3 –> 2.2.3
|a.b.C |属于补丁更新内容|2.0.3 –> 2.0.4

二.Bundle Identifier 命名

采用反域名命名规范，全部采用小写字母，以域名后缀+公司顶级域名+应用名形式命名，例如com.rogrand.dianbangbang

三.方法命名

动词或动名词，采用小驼峰命名法。
初始化数据方法： initData()
初始化布局方法：createView()
自定义布局方法：customView()
方法返回值为Bool类型的使用is或check为方法名前缀
返回获得某个值的方法，使用get作为方法名的前缀
返回获得某个对象的方法，使用fetch作为方法名的前缀
对数据进行处理的方法，使用handle作为方法名的前缀
增加保存操作：addXX() / saveXX()
修改操作： updateXX()
删除操作： deleteXX() / removeXX() / clearXX() / resetXX()
查找操作： findXX() / filterXX()
绘制布局： 使用draw作为方法名的前缀

四.变量命名

0.以private修饰符修饰的变量 以 m开头 （m是my的意思）
1.数组添加Arr后缀 例如：titleArr
2.字典添加Dic后缀 例如：userInfoDic
3.字符串变量命名：

类型	说明
页面标题	命名格式为：title_页面
按钮文字	命名格式为：btn_按钮事件
标签文字	命名格式为：label_标签文字
选项卡文字	命名格式为：tab_选项卡文字
消息框文字	命名格式为：toast_消息
编辑框的提示文字	命名格式为：hint_提示信息
图片的描述文字	命名格式为：desc_图片文字
对话框的文字	命名格式为：dialog_文字
menu的item文字	命名格式为：action_文字

4.表示距离的浮点型变量：
上边距以offsetY为变量名后缀
内补丁以padding为变量名后缀
外补丁以margin为变量名后缀

五.资源文件命名

按钮相关图片 以btn为文件前缀 例如 btn_main_home.png
分割线相关图片 以div为文件前缀 例如 div_maket_white.png
图标相关图片 以ic为文件前缀 例如 ic_edit.png
背景相关图片 以bg为文件前缀 例如 bg_main.png
默认相关图片 以def为文件前缀 例如 def_user_head.png
按钮不同状态下的图片命名：
默认状态： btn_xx_normal
聚焦状态： btn_xx_focused
不可用状态： btn_xx_disabled
高亮状态： btn_xx_pressed

六.对类的命名规范：

1.类名应首字母大写，并用驼峰格式分割单词,多使用类的扩展extension，少使用类的继承，例如需要在AppDelegate里定义几个方法用来配置比如推送相关的信息，即可定义一个AppDelegate+Notifition类，将需要实现的方法定义在此类中，然后留一个接口，在AppDelegate类里，程序启动方法中调用该接口
2.类命名以前缀+描述+类型形式
1)类型是ViewController的类，前缀可以是模块的名字如首页加上Home ，或者基类加上Base，类型是View或者是cell的类，前缀是开发者姓名/昵称的缩写，主要是用于团队开发的时候避免文件名重复
2)描述本类需要实现的哪些主要功能
3)类型：如控制器加上ViewController,协议Protocol加上Delegate,数据模型后缀加上Model，管理工具类后缀加上Manager或Tool。
例如：FYMessageCell.swift

七.viewController中的方法定义的位置参考下图

代码规范.png

八.使用插件

方法注释推荐使用VVDocumenter插件，定义属性写上注释

结语：安卓端应用开发规范可以参考darren_he