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

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

推荐阅读更多精彩内容

  • 文章来自https://github.com/Blankj/AndroidStandardDevelop#安卓开发...
    小庄bb阅读 756评论 0 1
  • iOS编程规范0规范 0.1前言 为􏰀高产品代码质量,指导广大软件开发人员编写出简洁、可维护、可靠、可 测试、高效...
    iOS行者阅读 4,459评论 21 35
  • Android编码规范 源文件基础 文件名 源文件以其最顶层的类名来命名,大小写敏感,文件扩展名为.java。 文...
    呼呼哥阅读 943评论 0 0
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,657评论 18 139
  • 很多人都说,咖啡是一种享受。泡在咖啡和音乐里,慢慢的啜饮,细细的品味,让咖啡融进思绪和周身的每一根神经。 当曾有的...
    音曼实验室阅读 1,056评论 0 1