背景
我们在平时的开发编程中,多多少少都会遇到一些功能的代码,当下不能很好的实现,或因为业务逻辑或因为思路,再或者因为时间。此时我们需要写一些// TODO:和// FIXME:的注释来提醒自己在的将来要去完善这些代码。今天这里给大家讲述下如何用好这些注释,并起到更好的作用。
使用SwiftLint
讲这里,有人疑惑不是要说TODO么,怎么又安利SwiftLint,SwiftLint是一个代码分析工具。SwiftLint中可以将// TODO注释标记为警告,当然SwiftLint还有更多的功能,也非常推荐Swift开发的同学接入,它能帮助我们更好的编写Swift代码
加上时间和标记
如开篇讲的,写上这类注释是为了后续更好的处理,所以加上时间和一些标记就显得很重要。如果是团队协作的项目,那么谁添加的TODO就应该备注上时间和自己的名字,这样可以很好的提醒自己,也能起到周知团队成员的作用。
标记TODO
上面讲的使用SwiftLint来为TODO标记警告,那么对于那些没有继承SwiftLint的工程来说,只能通过#warning来标记为警告了。当然,无论是用SwiftLint还是用户#warning,这都建立在你的项目工程警告非常少的基础上,如果工程动辄几百上千的警告,那么如果你还有给TODO加告警的心思,先把工程中原有的警告处理下吧🤣
总结
使用TODO是为了什么?是为了工程中没有TODO。
如果你要写TODO,问问自己为什么要写,问问自己什么时候可以处理
如果你看到你的队友写了,问他为什么要写,问他什么时候可以处理
网友评论