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
💡💡💡💡💡💡💡💡💡💡💡💡💡💡💡💡💡💡💡💡💡💡💡💡💡
5.其他注释
#warning 提示信息来提醒自己
// TODO:待做XXXX
网友评论