iOS 开发规范

命名规范

代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。正确的英文拼写和语法可以让阅读者易于理解,避免歧义。
大驼峰规则:每个单词的首字母大写。例:NameTextField。
小驼峰原则:第一个单词首字母小写,其余都大写。例:nameTextField

文件夹命名

创建文件夹最好创建实体文件夹,找到工程目录,创建相应文件夹并拖入工程。文件夹命名使用相应模块结构分层的英文,Contorller、Model、View、ViewModel、Service

版本规范

采用A.B.C 三位数字命名,比如:1.0.2,当有属于重大更新内容增加A(1.0.2 -> 2.00),小部分更新内容增加B(1.0.2 -> 1.1.0),补丁更新内容增加(1.0.2 -> 1.0.3)

第三方库规范

对开源库的选取,一般都需要选择比较稳定的版本,作者在维护的项目,要考虑作者对issue的解决,以及开发者的知名度等各方面。选取之后,一定的封装是必要的。项目使用cocoapods统一管理开源第三库文件,不需要手动导入和手动添加依赖库。如果第三方不支持cocoapods,可手动导入工程。

项目命名

项目名都遵循大驼峰命名。例如:WeChat。

Bundle Identifier 命名

Bundle Identifier:采用反域名命名规范,全部采用小写字母,以域名后缀+公司顶级域名+应用名形式命名,例如:com.wecat.tencent

类名

类的命名都遵循大驼峰命名。一般是:前缀 + 功能 + 类型。例如:WX + Login + ViewController 由于文件命名太长会影影响的左侧菜单文件名显示所以建议使用VC代替ViewController,VM代替ViewModel但是view、model依然建议使用全称
具体实例:
WXLoginVC 、WXLoginView、WXLoginModel、WXLoginVM、WXLoginCell
封装的基础组件等参照:
WXBaseButton、WXBaseLabel、WXBaseView、WXBaseTextField、WXBaseTextView
封装的功能view、工具类、代理等参照:
WXToastView 、WXTool、WXLoginTool、WXLoginDelegate、WXLoginManager、WXLoginService、WXUIButton+login

常量

宏:小写k+大驼峰 即为:#define kUserAgeKey @“ageKey”
全局常量:工程前+缀全大写,下划线隔开 即为:extern const NSString MW_USER_AGE_KEY

参数名

参数名以小驼峰命名,尽量参考苹果原生方法风格编写。尽量可读性好,看到方法名就知道这个方法是用来干什么的。参数应该避免用单个字符命名。
例:- (void)setDataImageUrl:(NSString *)imageUrl name:(NSString *)nameStr content:(NSString *)contentStr

资源文件命名

全部小写,采用下划线命名法,加前缀区分。所有的资源文件都需要加上。
命名模式:可加后缀small表示小图,big表示大图,逻辑名称可由多个单词加下划线组成,采用以下规则:
模块名
用途
逻辑名称、模块名用途颜色、用途逻辑名称、模块名用途_颜色
login_bg_image_normal

变量和方法

变量和方法的命名都遵循小驼峰命名。例如:name, isOpen,loginModel,- (void)clickAction响应事件。

常用方法命名

例如:
-(void)initView 初始化、创建、布局当前页面的UI控件
-(void)updateUI 加载 更新 布局
-(void)loadData 加载数据
-(void)loadMoreData 加载数据 一般用于带分页的请求
-(void)updateWithData:(id)data 一般用于根据数据传值(model)更新UI

注释规范

方法注释:方法外部统一用option + command + /,方法内部统一用//注释。如果该方法在.h文件有声明,那么建议把注释写在.h

/**
  吃东西的方法
  @param food 是的食物
 */
- (void)eatFood:(NSString *)food

模型注释:每个model中的,包含的每个属性,都必须要写上相对应的注释,用///注释。阅读者一看这个model,就清楚知道model中的每个字段代表的意思,用来做什么事情的。

@interface WXUserModel : NSObject
/// 用户名
@property (nonatomic, copy) NSString *name;
/// 密码
@property (nonatomic, copy) NSString *password;
@end

编码规范

  • 所有的方法之间空一行
  • 代码之间不允许无故出现大段的空行
  • 所有不易直接看懂的自定义的方法需要给出注释。
  • 代码后的“{”需要独占一行,包括方法之后,if,switch等。
  • 属性的定义请按照上面面例子property之后,空一格,括号之后空一格,写上类名,空一格之后跟上*和属性名。
  • 删除不用的代码,如果有方法一直不会用到,请删除(工具类另做考虑)。
  • 比较大的代码块需要给出注释。
  • 没有执行任何业务逻辑的方法,请删除或给予注释,删除多余的资源或文件
  • 提取方法,去除重复代码。对于必要的工具类抽取。
  • 尽可能的使用局部变量
  • 尽量减少对变量的重复计算。
  • 检测内存泄漏。可使用Instruments分析内存。
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 219,366评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,521评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 165,689评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,925评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,942评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,727评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,447评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,349评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,820评论 1 317
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,990评论 3 337
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,127评论 1 351
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,812评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,471评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,017评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,142评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,388评论 3 373
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,066评论 2 355

推荐阅读更多精彩内容

  • 前言 说是前言,其实也是本文诞生的目的。随着公司业务的不断增加,功能的快速迭代,app的业务线越来越多,代码体积变...
    梦翔_d674阅读 1,495评论 0 2
  • 前言说是前言,其实也是本文诞生的目的。随着公司业务的不断增加,功能的快速迭代,app的业务线越来越多,代码体积变得...
    Mr_yinwei阅读 643评论 0 0
  • 前言 本文是本宝宝参考自己的部分代码规范和网上众多其它小伙伴的代码规范,整理和写出的。规范涵盖了很多内容,阅读的小...
    肆意二货阅读 16,609评论 23 71
  • 导语: 为规范部门 iOS开发,特制定本文档,供各位同仁参考。 语言 使用US英语, 不要使用拼音。e.g:UIC...
    攻城狮V阅读 774评论 0 0
  • iOS代码编写规范Git的使用iOS进阶开发 目的 了利于项目维护以及规范开发,促进成员之间Code Review...
    CharlyZheng阅读 579评论 0 1