TODO 代辦事項 註解
TODO 代辦事項 註解
TODO 代辦事項 註解
TODO 代辦事項 註解
以//TODO形式留下一些待辦的筆記在註解裡,某些時候是合理的行為。
在下述例子中,TODO註解說明了為什麼要使用實作退化的函式,還有
未來應該要重構的樣子。
//TODO-MdM these are not needed
// We expect this to go away when we do the checkout model
protected VersionInfo makeVersion() throws Exception
{
return null;
}
TODO是程式設計師認為應該要完成的事情,但因為某些原因無法在此刻做到。
這種註解可能是提醒移除過時的功能,或者請某人注意某個問題。也可能是請
某人尋找更好的命名,或因著依賴於某個未來計劃而提醒所需要的修改。不管
這樣的TODO目標是什麼,都不應該成為讓糟糕程式碼留在系統裡的藉口。
現今,大部分不錯的IDE都提供了特別的功能來找出所有的TODO註解,所以
這些待辦事項不至於找不到。然而,你必須定期審視這些待辦事項,並且刪除
已經不再需要的待辦事項。