iOS开发注意事项及总结(一)

PS:请允许我在这里稍微的吐槽一下,现在负责的项目真是坑啊!
没有相关的需求文档。接口文档也不准确,经常找不到对应接口或者找错,项目起码一半的时间浪费在查找接口。没有iOS的相关切图。
🔥🔥 领导一句话:“打开手机按照安卓的做,功能自己点点,图嘛就先用安卓的。”
项目也快结束了,今天回顾了一下自己写的代码!!
MD,这是哪个SB写的代码,一种惨不忍睹的感觉!文件夹乱的,代码乱的,各种Model,都是因为需求不明确导致的东拼西凑啊。。所以准备整理一下,附赠一些自己理解整理的相关小技巧以及在一些大神那里学到的规范。如果有错误或者更好的地方请指正!🙏 🙏

一、 命名规范

1.不要使用拼音,数字以及不明含义的缩写
2.方法开头要小写,使用驼峰命名方式。
3.图片文件命名采用 type_location_identifier_state 规则,只需要@2x和@3x图片。
缩略前缀可用如下例子:icon、btn、bg、line、logo、pic、img
使用图片时候不要有 .png后缀,例如:
UIImage *settingIcon = [UIImage imageNamed:@"icon_common_setting"];

二、注释小技巧

好好写注释可以给自己和自己的小伙伴省下很多时间.
1.方法注释
Xcode8 更新之后,VVDocument插件不能使用,大家可以使用Xcode 自带的对方法进行注释。快捷键为: option(alt) + command + /
2.参数属性注释
大家可以使用


属性注释.png

在调用时会得到提示


属性注释1.png

3.方法分区
# pragma mark - xxx
# pragma mark xxx
带 - 的会显示一条分割线
方法区分.png

4.普通注释

普通注释.png

随便使用哪种都可以,看个人喜好。
使用// + 【空格】
💡💡💡💡💡💡💡💡💡💡💡💡💡💡💡💡💡💡💡💡💡💡💡💡💡
PS:小技巧,后三种注释方法可以添加到代码块里面,写起来会很方便,使用场景里最好勾选为All

![注释技巧1.png](http://upload-images.jianshu.io/upload_images/1377514-e476c7baaa22321f.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)

💡💡💡💡💡💡💡💡💡💡💡💡💡💡💡💡💡💡💡💡💡💡💡💡💡
5.其他注释
#warning 提示信息来提醒自己
// TODO:待做XXXX

附赠几个参考
iOS应用架构谈 view层的组织和调用方案
乐源移动开发团队 iOS 开发规范

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

推荐阅读更多精彩内容