代碼中特殊的註釋技術——TODO、FIXME和XXX的用處

作者:reille

本博客網址:http://blog.csdn.net/reille/,轉載本博客原創文章請註明出處。

本文內容概要: 代碼中特殊的註釋技術——TODO、FIXME和XXX的用處。

更多請關注:http://velep.com/

———————————————————————————————————————————————————————————————————

前言:
今天在閱讀Qt  Creator的源代碼時,發現一些註釋中有FIXME英文單詞,用英文詞典居然查不到其意義!
實際上,在閱讀一些開源代碼時,我們常會碰到諸如: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。
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章