Java代碼注釋TODO FIXME XXX的意義


特殊注釋:

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。

 

原文:http://free0007.iteye.com/blog/1886526

 

---------------------------------------------------------------------------------------------------------------------------------

“TODO”任務鏈接創建

  Eclipse可以提醒您仍需執行的任務。許多開發人員在代碼中添加TODO注釋來提醒他們還有特定的任務要完成,或者特定的情況要處理。Eclipse又一次利用它對Java結構的知識找到任何以TODO開頭的注釋,並將它添加到一個特殊的Tasks視圖(打開Window > Show View > Other > General > Tasks就可看到)。這樣,Eclipse可以提供一個全面的待完成的任務列表。

  此外,您還可以配置Eclipse去識別您定義的其他標簽。打開Preferences(Window Menu > Preferences)並瀏覽到“Task Tags”頁面(Java > Task Tags)。您就可以添加新標簽,刪除已有標簽,設置不同標簽的屬性,為代碼指定Eclipse提供的默認值。


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM