代碼中特殊的注釋技術(shù)--TODO、FIXME和XXX
發(fā)現(xiàn)一些注釋中有FIXME英文單詞,用英文詞典居然查不到其意義!
實(shí)際上,在閱讀一些開源代碼時(shí),我們常會(huì)碰到諸如:TODO、FIXME和XXX的單詞,它們是有其特殊含義的。
TODO: + 說明
如果代碼中有該標(biāo)示,說明在標(biāo)識(shí)處有功能代碼待編寫,待實(shí)現(xiàn)的功能在說明中會(huì)簡略說明。
FIXME: + 說明
如果代碼中有該標(biāo)識(shí),說明標(biāo)識(shí)處代碼需要修正,甚至代碼是錯(cuò)誤的,不能工作,需要修復(fù),如何修正會(huì)在說明中簡略說明。
XXX: + 說明
如果代碼中有該標(biāo)識(shí),說明標(biāo)識(shí)處代碼雖然實(shí)現(xiàn)了功能,但是實(shí)現(xiàn)的方法有待商榷,希望將來能改進(jìn),要改進(jìn)的地方會(huì)在說明中簡略說明。