代碼中特殊的注釋技術——TODO、FIXME和XXX的用處(轉)


1、聲明

本篇轉自博客:http://blog.csdn.net/reille/

 

2、轉載內容

2.1、前言

今天在閱讀 Qt Creator 的源代碼時,發現一些注釋中有 FIXME 英文單詞,用英文詞典居然查不到其意義!
實際上,在閱讀一些開源代碼時,我們常會碰到諸如:TODO、FIXME 和 XXX 的單詞,它們是有其特殊含義的

 

2.2、TODO: + 說明:

如果代碼中有該標識,說明在標識處有功能代碼待編寫,待實現的功能在說明中會簡略說明。

2.3、FIXME: + 說明:

如果代碼中有該標識,說明標識處代碼需要修正,甚至代碼是錯誤的,不能工作,需要修復,如何修正會在說明中簡略說明。

2.4、XXX: + 說明:

如果代碼中有該標識,說明標識處代碼雖然實現了功能,但是實現的方法有待商榷,希望將來能改進,要改進的地方會在說明中簡略說明。

2.5、eclipse 中特殊的注釋:

在 eclipse 中,TODO、FIXME 和 XXX 都會被 eclipse 的 task 視圖所收集。

在項目發布前,檢查一下task視圖是一個很好的習慣。

此外,在 eclipse 中,我們可自定義自己的特殊注釋標簽。

如在 C/C++中,進入window —> preferences —> C/C++ —>Task Tags 窗口即可添加特殊標簽,默認只有 TODO、FIXME 和 XXX 。

 

3、最后

對於自己寫的不太確定的部分,並且眼下又沒有人來參與討論,那么,可以用 XXX 的形式來標注,並且寫一下當時的思路注解,這樣上線前,檢查一下,就不會因為忘記而造成一些不必要的麻煩。

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM