代码中特殊的注释技术——TODO、FIXME和XXX的用处
為什么80%的碼農(nóng)都做不了架構(gòu)師?>>> ??
在閱讀一些開源代碼時(shí),我們常會碰到諸如:TODO、FIXME和XXX的單詞,它們是有其特殊含義的。
TODO: + 說明:
如果代碼中有該標(biāo)識,說明在標(biāo)識處有功能代碼待編寫,待實(shí)現(xiàn)的功能在說明中會簡略說明。
FIXME: + 說明:
如果代碼中有該標(biāo)識,說明標(biāo)識處代碼需要修正,甚至代碼是錯(cuò)誤的,不能工作,需要修復(fù),如何修正會在說明中簡略說明。
XXX: + 說明:
如果代碼中有該標(biāo)識,說明標(biāo)識處代碼雖然實(shí)現(xiàn)了功能,但是實(shí)現(xiàn)的方法有待商榷,希望將來能改進(jìn),要改進(jìn)的地方會在說明中簡略說明。
eclipse中特殊的注釋:
在eclipse中,TODO、FIXME和XXX都會被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。
轉(zhuǎn)載于:https://my.oschina.net/yjft/blog/701778
總結(jié)
以上是生活随笔為你收集整理的代码中特殊的注释技术——TODO、FIXME和XXX的用处的全部內(nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: golang内置数据类型作为函数参数
- 下一篇: A标签的href设置为#代表什么意思?