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)程序中出现加密/解密 逻辑的操作地方,需要给出注释说明过程(无论是系统还是自定义)

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,099评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,828评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,540评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,848评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,971评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,132评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,193评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,934评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,376评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,687评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,846评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,537评论 4 335
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,175评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,887评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,134评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,674评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,741评论 2 351

推荐阅读更多精彩内容

  • 命名原则 1.基本原则 (1)清晰。 命名应该是以清晰为主、简洁为辅。总的来讲不要使用单词的简写,除了使用非常常见...
    MichaelHuyp阅读 3,202评论 2 28
  • 此文档根据apple,google以及行业中比较知名的OC编码规范整理归纳而成,旨在为大家的iOS开发规范提供一份...
    若小北00阅读 512评论 0 0
  • 移动端iOS开发规范文档 序言 根据网上的一些OC编码规范整理归纳而成,为了利于项目维护以及规范开发,促进成员之间...
    Living_U阅读 706评论 0 1
  • 版权声明:本文为博主原创文章,未经博主允许不得转载。转载请注明转至Z.MJun的简书 1. 每一行的字数限制 80...
    ZMJun阅读 1,525评论 0 1
  • 移动端iOS开发规范文档 目录 格式与换行 命名 Objective-C下的cocoa编码规范 注释要求 其他 参...
    志城阅读 4,712评论 1 6