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

Java程式碼註釋TODO FIXME XXX的意義

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

表示需要實現,但目前還未實現的功能

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

程式碼是錯誤的,不能工作,需要修復

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

勉強可以工作,但是效能差等原因

eclipse中特殊的註釋:
在eclipse中,TODO、FIXME和XXX都會被eclipse的task檢視所收集。在專案釋出前,檢查一下task檢視是一個很好的習慣。此外,在eclipse中,我們可自定義自己的特殊註釋標籤。如在C/C++中,進入window—>preferences—>C/C++—>Task Tags視窗即可新增特殊標籤,預設只有TODO、FIXME和XXX。