Tip:iOS开发中关于TODO的用法

背景

我们在平时的开发编程中,多多少少都会遇到一些功能的代码,当下不能很好的实现,或因为业务逻辑或因为思路,再或者因为时间。此时我们需要写一些// TODO:和// FIXME:的注释来提醒自己在的将来要去完善这些代码。今天这里给大家讲述下如何用好这些注释,并起到更好的作用。

使用SwiftLint

讲这里,有人疑惑不是要说TODO么,怎么又安利SwiftLint,SwiftLint是一个代码分析工具。SwiftLint中可以将// TODO注释标记为警告,当然SwiftLint还有更多的功能,也非常推荐Swift开发的同学接入,它能帮助我们更好的编写Swift代码

加上时间和标记

如开篇讲的,写上这类注释是为了后续更好的处理,所以加上时间和一些标记就显得很重要。如果是团队协作的项目,那么谁添加的TODO就应该备注上时间和自己的名字,这样可以很好的提醒自己,也能起到周知团队成员的作用。

标记TODO

上面讲的使用SwiftLint来为TODO标记警告,那么对于那些没有继承SwiftLint的工程来说,只能通过#warning来标记为警告了。当然,无论是用SwiftLint还是用户#warning,这都建立在你的项目工程警告非常少的基础上,如果工程动辄几百上千的警告,那么如果你还有给TODO加告警的心思,先把工程中原有的警告处理下吧🤣

总结

使用TODO是为了什么?是为了工程中没有TODO。
如果你要写TODO,问问自己为什么要写,问问自己什么时候可以处理
如果你看到你的队友写了,问他为什么要写,问他什么时候可以处理

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

相关阅读更多精彩内容

  • 还是本着全网高收低出的做法、可货比三家哟。 收贝:0.190/贝卖贝:0.215贝 温馨提示 19万的钻作为担保、...
    大猪大猪阅读 1,589评论 1 3
  • 空气失去了氧气,路灯失去了光明,星空失去了斑点,月光看不到了。好久不见夜晚。
    现实就是生活阅读 906评论 0 2
  • 有一种美 叫做人间冬月 雪花飘零而至的瞬间 任由时光搁浅 望穿秋水 一眼万年 无根的花若隐若现 缓缓绽放了世间 我...
    猫之灵阅读 2,976评论 0 2
  • 去年夏天,粗心的我突然被诟病有斑。细看,果然脑门上有一处银杏叶大小的浅咖色斑,脸颊两侧也有零星的雀斑似的斑点。 之...
    xuehuikuaile阅读 2,701评论 3 5
  • 一、ES5有关异步的处理方式 二、ES6使用promise改变ES5的回调地狱问题 2-1状态 pending 等...
    jcxe阅读 1,738评论 0 0

友情链接更多精彩内容