背景
我們在平時的開發(fā)編程中箍铲,多多少少都會遇到一些功能的代碼,當下不能很好的實現(xiàn),或因為業(yè)務(wù)邏輯或因為思路触机,再或者因為時間。此時我們需要寫一些// TODO:和// FIXME:的注釋來提醒自己在的將來要去完善這些代碼。今天這里給大家講述下如何用好這些注釋儡首,并起到更好的作用销斟。
使用SwiftLint
講這里,有人疑惑不是要說TODO么椒舵,怎么又安利SwiftLint蚂踊,SwiftLint是一個代碼分析工具。SwiftLint中可以將// TODO注釋標記為警告笔宿,當然SwiftLint還有更多的功能犁钟,也非常推薦Swift開發(fā)的同學(xué)接入,它能幫助我們更好的編寫Swift代碼
加上時間和標記
如開篇講的泼橘,寫上這類注釋是為了后續(xù)更好的處理涝动,所以加上時間和一些標記就顯得很重要。如果是團隊協(xié)作的項目炬灭,那么誰添加的TODO就應(yīng)該備注上時間和自己的名字醋粟,這樣可以很好的提醒自己,也能起到周知團隊成員的作用重归。
標記TODO
上面講的使用SwiftLint來為TODO標記警告米愿,那么對于那些沒有繼承SwiftLint的工程來說,只能通過#warning來標記為警告了鼻吮。當然育苟,無論是用SwiftLint還是用戶#warning,這都建立在你的項目工程警告非常少的基礎(chǔ)上椎木,如果工程動輒幾百上千的警告违柏,那么如果你還有給TODO加告警的心思,先把工程中原有的警告處理下吧??
總結(jié)
使用TODO是為了什么香椎?是為了工程中沒有TODO漱竖。
如果你要寫TODO,問問自己為什么要寫畜伐,問問自己什么時候可以處理
如果你看到你的隊友寫了馍惹,問他為什么要寫,問他什么時候可以處理