代码注释技术
前言:
今天在閱讀Qt ?Creator的源代碼時(shí),發(fā)現(xiàn)一些注釋中有FIXME英文單詞,用英文詞典居然查不到其意義!
實(shí)際上,在閱讀一些開(kāi)源代碼時(shí),我們常會(huì)碰到諸如:TODO、FIXME和XXX的單詞,它們是有其特殊含義的。
TODO: + 說(shuō)明:
如果代碼中有該標(biāo)識(shí),說(shuō)明在標(biāo)識(shí)處有功能代碼待編寫,待實(shí)現(xiàn)的功能在說(shuō)明中會(huì)簡(jiǎn)略說(shuō)明。
FIXME: + 說(shuō)明:
如果代碼中有該標(biāo)識(shí),說(shuō)明標(biāo)識(shí)處代碼需要修正,甚至代碼是錯(cuò)誤的,不能工作,需要修復(fù),如何修正會(huì)在說(shuō)明中簡(jiǎn)略說(shuō)明。
XXX: + 說(shuō)明:
如果代碼中有該標(biāo)識(shí),說(shuō)明標(biāo)識(shí)處代碼雖然實(shí)現(xiàn)了功能,但是實(shí)現(xiàn)的方法有待商榷,希望將來(lái)能改進(jìn),要改進(jìn)的地方會(huì)在說(shuō)明中簡(jiǎn)略說(shuō)明。
eclipse中特殊的注釋:
在eclipse中,TODO、FIXME和XXX都會(huì)被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。
?
visual studio 中打開(kāi)方式 ctrl+W,T
轉(zhuǎn)載于:https://www.cnblogs.com/shengwei/p/4747798.html
總結(jié)
- 上一篇: javascript document对
- 下一篇: 第 5 章 第二个 activity