iOS开发规范文档
1文件组织结构
1.1结构说明
1) iOS工程文件结构分物理结构(controller) 和逻辑结构(Logic) ,逻辑结构和物理结构保持一致,以便方便有效地管理类文件。类文件组织要遵循以下两大原则:基于MVC设计模式原则,至少要保证controller与数据处理,网络请求相对独立基于功能模块原则,功能模块分包括数据/网络处理,UI前端界面两部分,数据/网络处理应该在数据/网络处理的框架下,而UI前端界面比如用户中心,消息中心,它们的专有的controller,view等应该在属于文件夹。还会遇到一些公共的view,放在Other公共的文件夹来管理
2) 图片资源文件采用Images.xcassets管理,不要使用自己创建的文件夹管理。
1.2结构框架
|____ WanWuZhiLian 项目入口文件目录
|___ Base(基础) 项目文件的基类
| |___BaseViewConeroller项目ViewConeroller的基类,所有的ViewConeroller都继承这个基类
|___ Main(主要) 项目模块目录
| |___ Login(登录) 登录模块
| | |___ Controller存放登录模块所有的控制器目录
| | |___ 存放登录模块所有的视图目录
| | |___ Model存放登录模块所有的数据模型目录
| | |___ Logic存放登录模块所有的逻辑文件目录
| | |___ Other存放公共的View
| |___Home(首页) 首页模块
| |___Controller存放首页模块所有的控制器目录
| |___View存放首页模块所有的视图目录
| |___Model存放首页模块所有的数据模型目录
| |___Logic存放首页模块所有的逻辑文件目录
| | |___ Other存放公共的View
|___ Expand(拓展) 拓展的工具文件目录
| |___Categray(分类) 项目的所有类的扩展文件目录
| |___Macros(宏) 项目自定义宏的文件目录
| |___CommonMacros.h项目所有宏定义的Key 定义文件
| |___FontAndColorMacros.h项目所有宏定义文字大小 颜色
| |___ThirdMacros.h项目所有第三方宏定义的Key
| |___URLMacros.h项目所有请求接口的宏定义,WEB的URL宏定义|
| |___UtilsMacros.h其他宏定义的文件
|___ Manager(管理器) 项目所有单例类目录,例如:UserManager等
|___ Network(网络) 项目网络层目录
|___ Vender(第三方) 第三方库目录 例如:爱康SDK,腾讯IM等
|___ Resource(资源) 项目资源目录,存放本的语音等文件
2命名规则
2.1基本规则
清晰。命名应该是以清晰为主、简洁为辅。总的来讲不要使用单词的简写,除了使用非常常见的简写以外,尽量使用单词的全称。不可使用拼音、数字、容易让人看不懂易混淆的词命名。自定义API(造轮子)时,API的名称不要有歧义并且不要与苹果原生API产生冲突,让使用者一看你的API就知道是以什么方式用来做什么的
2.2类命名
类名应该遵循驼峰命名原则。类名中应该包含一个或多个单词来描述这个方类(或类对象)是做什么的。
2.3类别命名
类名+个人识别(WW)+拓展名
例如UIView+WWExtension
类别的方法应该使用个人标识前缀(统一用ww)加下划线加方法名避免与项目中的其他方法产生冲突。详情参考SDWebImage的sd_setImage:方法...
2.4方法命名
方法使用小驼峰法命名, 一个规范的方法读起来应该像一句完整的话,读过之后便知函数的作用。执行性的方法应该以动词开头,小写字母开头,返回性的方法应该以返回的内容开头,但之前不要加get。如果有参数,函数名应该作为第一个参数的提示信息,若有多个参数,在参数前也应该有提示信息(一般不必加and)一些经典的操作应该使用约定的动词,如initWith,insert,remove,replace,add等等。
示例:
命名说明
insertObject:atIndex:规范的写法
insert:at:不清晰,插入什么?at代表什么?
removeObjectAtIndex:规范的写法
removeObject:规范的写法,因为参数指明了要移除一个对象
remove:不清晰,移除什么?
2.5变量命名
[if !supportLists]1) [endif]变量名使用小驼峰命名规则,使变量名尽可能可以推测其用途。
[if !supportLists]2) [endif]类的成员变量用小驼峰命名法并加上下划线开头的方式命名。
[if !supportLists]3) [endif]一般变量命名请使用简洁明了的方式并且开头不要使用下划线
2.6常量命名
常量(预定义,枚举,局部常量等)使用小写k开头的驼峰法
2.7图片资源文件命名
这个图片资源命名方式,以功能为组织形式,有利于查看资源文件。
原则:
1)采用单词全拼,或者大家公认无岐义的缩写(比如:nav,bg,btn等)
2)采用“模块+功能”命名法,模块分为公共模块、私有模块。公共模块主要包括统一的背景,导航条,标签,公共的按钮背景,公共的默认图等等;私有模块主要根据app的业务功能模块划分,比如用户中心,消息中心等
备注:背景图采用以bg作前缀,按钮背景采用btn作前缀)
公共模块命名示例:
导航条背影图片:bg_nav_bar@2x.png
导航返回按钮:bg_nav_back_normal@2x.png,bg_nav_back_selected@2x.png
标签item背景:bg_tabbar_record_normal@2x.png,bg_tabbar_record_selected@2x.png
私有模块命名示例:
以APP的用户中心图片资源为例说明,
uc——user center
用户中心头像默认图:bg_uc_avatar@2x.png
用户中心顶部默认背景图:bg_uc_top_defaut@2x.png
用户中心底部背景图:bg_uc_bottom@2x.png
3代码规范
3.1代码结构
#pragma mark – Lifecycle --->生命周期
-(instancetype)init {}
-(void)dealloc {}
-(void)viewDidLoad {}
-(void)viewWillAppear:(BOOL)animated {}
- (void)didReceiveMemoryWarning{}
#pragma mark - Custom Accessors --->自定义访问器
-(void)setCustomProperty:(id)value {}
-(id)customProperty {}
#pragma mark - IBActions--->按钮事件
-(IBAction)submitData:(id)sender {}
#pragma mark - Public--->公开方法
- (void)publicMethod{}
#pragma mark - Private--->私有方法
-(void)privateMethod {}
#pragma mark - UITextFieldDelegate--->表代理
#pragma mark - UITableViewDataSource
#pragma mark - UITableViewDelegate
#pragma mark - NSCopying--->编码
-(id)copyWithZone:(NSZone *)zone {}
#pragma mark – Sets && Gets--->懒加载
-(NSString *)description {}
3.2代码规范
1.删除多余的空行
(1) 所有方法与方法之间空1行
(2)所有代码块之间空1行
2.删除多余的注释
(1)删除注释掉的代码
(2)删除没有意义的注释
3.删除多余的方法
(1)如果方法没有使用到,请删除它
(2)如果方法没有执行任何业务逻辑,请删除它或者给出一定注释
4.删除未被使用的资源文件5.添加必要的注释
(1)所有 .h 文件中的property 需要给出注释
(2)所有自定义的方法需要给出注释
(3)比较大的代码块需要给出注释
(4)所有代码中出现的阿拉伯数字需要给出注释
(5)程序中出现加密/解密 逻辑的操作地方,需要给出注释说明过程(无论是系统还是自定义)