Java代碼注釋XXX todo fixme 的意義

特殊注釋:

  1. TODO
    表示需要實(shí)現(xiàn),但目前還未實(shí)現(xiàn)的功能
  2. XXX
    勉強(qiáng)可以工作,但是性能差等原因
  3. FIXME
    代碼是錯(cuò)誤的,不能工作,需要修復(fù)
  • TODO: + 說明:
    如果代碼中有該標(biāo)識(shí),說明在標(biāo)識(shí)處有功能代碼待編寫,待實(shí)現(xiàn)的功能在說明中會(huì)簡(jiǎn)略說明。

  • FIXME: + 說明:
    如果代碼中有該標(biāo)識(shí),說明標(biāo)識(shí)處代碼需要修正,甚至代碼是錯(cuò)誤的,不能工作,需要修復(fù),如何修正會(huì)在說明中簡(jiǎn)略說明。

  • XXX: + 說明:
    如果代碼中有該標(biāo)識(shí),說明標(biāo)識(shí)處代碼雖然實(shí)現(xiàn)了功能,但是實(shí)現(xiàn)的方法有待商榷,希望將來能改進(jìn),要改進(jìn)的地方會(huì)在說明中簡(jiǎn)略說明。

eclipse中特殊的注釋:
在eclipse中,TODO、FIXME和XXX都會(huì)被eclipse的task視圖所收集。在項(xiàng)目發(fā)布前,檢查一下task視圖是一個(gè)很好的習(xí)慣。此外,在eclipse中,我們可自定義自己的特殊注釋標(biāo)簽。如在C/C++中,進(jìn)入window—>preferences—>C/C++—>Task Tags窗口即可添加特殊標(biāo)簽,默認(rèn)只有TODO、FIXME和XXX。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容