【Java】总结//TODO、//FIXME、//XXX 注释
生活随笔
收集整理的這篇文章主要介紹了
【Java】总结//TODO、//FIXME、//XXX 注释
小編覺得挺不錯的,現在分享給大家,幫大家做個參考.
TODO、FIXME、XXX
- //TODO : 表示待實現的功能
- //FIXME: 代碼存在Bug,不能Run或運行結果不正確,需要修復
- //XXX ?: 勉強可以工作,但是實現的方法不一定很好
TODO
//TODO something顧名思義,//TODO說明標識處有功能代碼未實現,待實現的功能說明會在//TODO后面簡略表述。
FIXME
//FIXME something顧名思義,//FIXME說明標識處代碼需要修正。被//FIXME表示的代碼基本是錯誤的、不能工作的、需要修復的,修正的說明會在//FIXME后面簡略表述。
XXX
//XXX something如果代碼中有//XXX,說明標識處代碼雖然實現了功能,但是實現的方法不一定很好,留待商榷并希望未來版本中能改進,要改進的說明會在//XXX后面簡略表述。
IDE顯示
Eclipse
除了TODO和FIXME,XXX還是識別的
IntelliJ IDEA
只識別TODO和FIXME,不識別XXX
Eclipse-Tasks欄視圖
所有的特殊注釋都會被識別,我沒額外配置,其實自己可以調的。
Eclipse自動生成的TODO注釋
Eclipse可以自動生成TODO注釋,我印象中有catch語句塊和重寫構造器、方法……
catch塊的TODO
catch塊之所以標上TODO主要是為了告訴開發者,應該去做好異常處理而不是簡簡單單的拋出異常或者打印異常棧。
構造器和重寫方法的TODO
生成的TODO是也是提醒開發者不要空有殼子,應該認真地編寫具體的實現代碼。
說明
雖然我們知道了三者的實際表示的意義,但標注歸標注,標注的目的是為了解決問題,讓程序更加Nice。所以怎么加上的,就怎么努力更正并刪去吧!
總結
以上是生活随笔為你收集整理的【Java】总结//TODO、//FIXME、//XXX 注释的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 【操作系统】常见进程调度算法特点总结比较
- 下一篇: 【Java】数值计算排雷指南