iOS编码规范整理(供参考)

每个公司甚至每个程序员都有自己的一套编码习惯,个体不同,风格自然是迥异的,为了项目的代码质量,团队往往会制定自己的编码规范。这是我们整理的编码规范,发表出来供大家参考哟。
iOS 编码规范
时间:2017-05-10 版本:1.0

前言:规范的编码可以避免很多问题,提高项目的稳定性,也增加了易读性和可维护性,所以,现在初步建立一套编码规范,之后再逐步完善。

1、命名规范
原则:
1)可读性高;
2)防止命名冲突;

类的命名
命名规范:
类名首字母大写,遵循OC语言的命名规范。类名要有实际的意义,如果类名太长,可
以省略一些不影响实际意义的单词,稍作简写。例如:
HomePageItemViewController ——> HomePageItemController
省略中间的view,大家依然知道它是一个VC,并不影响实际意义和可读性。
命名规则:
文件夹名字——类名——所属MVC类型结尾
例如:
HomeDetailViewController,————控制器
HomeDetailCell,————————-视图显示器
HomeDetailModel————————数据模型

变量命名
变量名称要有实际意义;
变量命名遵循OC的驼峰式命名规范;
如果是一个View,要以实际类型结尾;
变量名保持全英文结构,不要出现数字。
例如:cancelButton,titleLabel

常量命名
常量命名以m开头;
遵循驼峰命名规范;
例如:#define mScreenWidth ([UIScreen mainScreen].bounds.size.width)

方法名命名
小写字母开头;
有实际意义;
方法名前面一定要有注释;
公有方法最好以类名开头。
例如:
/**

  • 保存图片到相册
  • @param image 图片
  • @param success 成功回调
  • @param failure 失败回调
    /
    / + (void)saveImageToAppAlbum:(UIImage
    )image success:(void (^)())success failure:(void (^)(NSError *error))failure;

2、资源文件

图片资源

资源文件存储按照功能分类,按照现有项目举例,项目中有“首页”,“订阅”,“发现”,“我”四个模块,图片资源就按照如下图大致分类:

image.png

图片资源的命名要遵循“文件夹名字”—“子文件名字”—“图片名字”,如果图片名字很长的情况下,可以省略最外层文件夹名字,不过不建议省略。图片命名一定要是英文,禁止出现中文命名。

image.png

音频,json,plist等其他资源文件

其他资源放在Supporting Files文件夹下,资源文件注意命名。

image.png

3、项目结构

现在项目的整体结构还是可以的,只是业务文件夹有些乱,没怎么整理。
项目结构上还是遵循MVC结构,按照功能分,一个模块一个文件夹,再加上三方库(如果使用pods,这个文件夹基本可以省略),Common文件夹

image.png

Bussiness文件夹——业务

image.png

home——首页

image.png

Common——公共

image.png

类中方法顺序(这个协商决定就好)
从上到下依次是:

image.png

重写父类的方法——> get/set——> 点击方法 ——> 自定义方法 ——> 代理方法

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

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,358评论 25 707
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,579评论 18 139
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,717评论 6 342
  • 就像是有人喜欢炒股,而有的人喜欢炒“物”,就比如一些私人收藏的古董字画,又或者是一些名贵少见的药材等。前几天有个新...
    大能猫猫阅读 287评论 0 0
  • 清除浮动之前需注意两点:1、清除浮动一定要在完成布局之后。2、清除浮动必须与前面的浮动标签属于同级关系。 1、空标...
    蚊子简叔阅读 241评论 0 0