代碼中特殊注釋——TODO、FIXME、XXX、HACK

在平時(shí)的編程中,總是能在一些編譯器自動(dòng)生成的代碼或者大佬的程序中看到//TODO ...的注釋?zhuān)恢焙芤苫蟮降资鞘裁匆馑?,以為是個(gè)注釋規(guī)范,其實(shí)是項(xiàng)目管理者要求代碼編寫(xiě)人員在式樣無(wú)法確定,或者其他原因不能完成編程的時(shí)候,用// TODO進(jìn)行注釋?zhuān)敲垂芾碚呔涂梢噪S時(shí)的通過(guò)任務(wù)列表查看工作狀況和問(wèn)題點(diǎn)來(lái)進(jìn)行控制。

? ? 在intellij中可以設(shè)置自己專(zhuān)屬的TODO,設(shè)置自己專(zhuān)屬的TODO表示用來(lái)在一個(gè)多人合作的項(xiàng)目中與別人的TODO分別開(kāi)來(lái)(默認(rèn)是深藍(lán)色):

TODO:英語(yǔ)翻譯為待辦事項(xiàng),備忘錄。如果代碼中有該標(biāo)識(shí),說(shuō)明在標(biāo)識(shí)處有功能代碼待編寫(xiě),待實(shí)現(xiàn)的功能在說(shuō)明中會(huì)簡(jiǎn)略說(shuō)明。

FIXME:可以拆成短語(yǔ),fix me ,意為修理我。如果代碼中有該標(biāo)識(shí),說(shuō)明標(biāo)識(shí)處代碼需要修正,甚至代碼是錯(cuò)誤的,不能工作,需要修復(fù),如何修正會(huì)在說(shuō)明中簡(jiǎn)略說(shuō)明。

XXX:如果代碼中有該標(biāo)識(shí),說(shuō)明標(biāo)識(shí)處代碼雖然實(shí)現(xiàn)了功能,但是實(shí)現(xiàn)的方法有待商榷,希望將來(lái)能改進(jìn),要改進(jìn)的地方會(huì)在說(shuō)明中簡(jiǎn)略說(shuō)明。

HACK:英語(yǔ)翻譯為砍。如果代碼中有該標(biāo)識(shí),說(shuō)明標(biāo)識(shí)處代碼我們需要根據(jù)自己的需求去調(diào)整程序代碼。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書(shū)系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容