1. 程式人生 > >註釋XXX、TODO、FIXME的意義

註釋XXX、TODO、FIXME的意義

意義 inf reference 特殊 窗口 info http ima clip

特殊註釋:
1 TODO
表示需要實現,但目前還未實現的功能
2 XXX
勉強可以工作,但是性能差等原因
3 FIXME
代碼是錯誤的,不能工作,需要修復

TODO: + 說明:
如果代碼中有該標識,說明在標識處有功能代碼待編寫,待實現的功能在說明中會簡略說明。

FIXME: + 說明:
如果代碼中有該標識,說明標識處代碼需要修正,甚至代碼是錯誤的,不能工作,需要修復,如何修正會在說明中簡略說明。

XXX: + 說明:
如果代碼中有該標識,說明標識處代碼雖然實現了功能,但是實現的方法有待商榷,希望將來能改進,要改進的地方會在說明中簡略說明。

eclipse中特殊的註釋:
在eclipse中,TODO、FIXME和XXX都會被eclipse的task視圖所收集。在項目發布前,檢查一下task視圖是一個很好的習慣。此外,在eclipse中,我們可自定義自己的特殊註釋標簽。如在C/C++中,進入window—>preferences—>C/C++—>Task Tags窗口即可添加特殊標簽,默認只有TODO、FIXME和XXX。

技術分享圖片

註釋XXX、TODO、FIXME的意義