swift编码规范(实时更新)

命名:

1.使用帕斯卡拼写法(又名大骆驼拼写法,首字母大写)为类型命名 (如 struct, enum, class, typedef, associatedtype 等)。

2.定义变量:命名建议用驼峰式命名,如myName。第一个单词首字母小写,后面其他单词首字母大写。或者匈牙利命名法,如strMyName,intMyAge。开头字母用变量类型的缩写,其他单词首字母大写,这样在回顾代码时能很清晰的看到变量的类型。(命名不要简写成单个字母,尽量能从名字表达这个变量的用途)

3.方法命名:命名时最好能够英译所表达的意思,且备注这个方法的作用。可以有道词典等多种途径。备注是有助于你自己回看,并使别人更加容易的阅读你的代码。例如:


4.使用 // MARK: 注释来分割协议实现和其他代码。如果这个方法是一个你当前代码开端,可以用// MARK: - 下一步来进行备注。这样对你寻找代码帮助很大。

5.如果方法带有参数,可以在方法名的上面(空白)的地方按 Command + Option + /这样才管用


判断:

1.左大括号不用另起一行,swift里if不必要接(),如果判断条件非常复杂,可以先对判断条件进行赋值(这样更便于代码阅读)

2.因为Swift 中的 switch 选项默认是包含break的, 如果不需要不用使用 break 关键词。

3.case 语句 应和 switch 语句左对齐,并在 标准的 default 上面。


写法:

1.在写枚举类型的时候,尽量简写。

2. 在使用类方法的时候不用简写,因为类方法不如 枚举 类型一样,可以根据轻易地推导出上下文。


5.尽量不要使用as!

6.不要使用 += 或 + 操作符给数组添加新元素,使用性能较好的.append() 或.appendContentsOf(),如果需要声明数组基于其他的数组并保持不可变类型, 使用 let myNewArray = [arr1, arr2].flatten(),而不是let myNewArray = arr1 + arr2 。

7.建议可在失败情形下退出当前上下文的场景下使用 guard 语句。

8.在二元操作符譬如+, ==, 或者 ->的前后需要加上空格,整体更简洁,便于阅读。

图片管理:

1.项目里能够用代码实现的尽量不用图片。


2.图片的命名要在一开始定好规则,例如分模块命名等,这样便于对图片的管理。如果不是网络获取图片,而图片的更换比较频繁,那么在需要更换图片以及去掉某些页面之后能够比较准确的找到并删除图片。毕竟图片所占内存挺大的。

例如:在Assets.xcassets将图片分组


编码规范会使得你的代码整洁,可读性高。同时整个团队在代码修改,维护,审查的效率也会大大提高。统一规范,就是你的团队,向着更好的方向迈出的第一步。


————————————我是分割线————————————————

2017-05-23再次更新

多人开发项目(工具Cornerstone)

1.每次对代码有更改要在文件中备注。例如:

2.用Cornerstone(代码管理类工具)进行提交时要备注:姓名+提交内容的简要。例如:xxx—修改手机号功能。

3.很多人刚开始使用Cornerstone时,项目包经常就被玩死了,然后呢有备份的就要重新上传,没有备份的就要想办法复原到能用的版本,如果百度都没法复原,那就挺惨的。

其实基本的提交时不会对项目包有很大影响的,但是如果乱提交一些动就有可能会导致不好的后果。例如:



.xcworkspace的文件基本不要动,项目是用cocoapods管理第三方库的,如果你对第三方库有了修改就会提示你可以提交这个。但是我目前没成功过,如果我新增了一个第三方库并提交,项目包就炸了,各种报错弄不好。(有知道的大牛可以留言告诉我怎么操作)  我一般都是框架包整理好了之后上传,然后大家基于这个框架包进行开发。如果中途要加框架,那么会提醒所有人,我会将目前的包本地加入某框架重新上传,如果有要改动代码的在新的包进行改动,或改动好后记得在新包进行同样的改动。

project.pbxproj这个文件只需要在你提交新的文件,例如新开发的功能,添加了xxxxx.swift文件,那么就要把project.pbxproj和xxxxx.swift一起提交(Commit)。如果是新增图片就不需要上传这个。

如果xxx.xcodeproj文件破坏,多人乱提交,项目包损坏了(刚开始非常容易发生!)。

点击Revert


然后点击蓝色的那个—Copy to Trash First就可以好。

删除也容易出问题! 删除需要你先将本地项目中的文件删掉,然后Cornerstone会是这个样子

选中这两个感叹号的文件,反键Delete

变成这样之后,将两个D的文件选中和project.pbxproj一起提交。如果是删除图片就直接将变成D的图片文件提交就好。

总结:不要提交.xcworkspace的文件,图片的新增和删除直接提交,文件的新增和删除要和project.pbxproj一起提交。(如果你在新增或删除文件是没有提交project.pbxproj,只提交了文件,项目不会有问题。但是需要更新之后的人手动去找到要删除的文件目录,或者手动去找到要添加文件的模块添加文件进去)


最近有点忙,但是想到什么要点会及时写出来分享给大家

转载请注明出处,谢谢!

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

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,275评论 25 707
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,566评论 18 139
  • 风境羽阅读 321评论 0 2
  • 在近100年里,人类从电气时代走向了信息时代,最具表现的就是互联网的诞生,在过去的前几十年里,互联网发展早期的时候...
    万能天哥阅读 420评论 0 5
  • 出来浪荡一周后,我踏上了回家的路,细数八月过半,算是圆了初中毕业时的梦了吧,从初中就在外上学的好处就是省内遍地是同...
    personneye阅读 257评论 0 0