原始碼中TODO、FIXME和XXX的含義
前言:
今天在閱讀Qt Creator的原始碼時,發現一些註釋中有FIXME英文單詞,用英文詞典居然查不到其意義!
實際上,在閱讀一些開原始碼時,我們常會碰到諸如:TODO、FIXME和XXX的單詞,它們是有其特殊含義的。、
TODO: + 說明:
如果程式碼中有該標識,說明在標識處有功能程式碼待編寫,待實現的功能在說明中會簡略說明。
FIXME: + 說明:
如果程式碼中有該標識,說明標識處程式碼需要修正,甚至程式碼是錯誤的,不能工作,需要修復,如何修正會在說明中簡略說明。
XXX: + 說明:
如果程式碼中有該標識,說明標識處程式碼雖然實現了功能,但是實現的方法有待商榷,希望將來能改進,要改進的地方會在說明中簡略說明。
eclipse中特殊的註釋:
今天在閱讀Qt Creator的原始碼時,發現一些註釋中有FIXME英文單詞,用英文詞典居然查不到其意義!
實際上,在閱讀一些開原始碼時,我們常會碰到諸如:TODO、FIXME和XXX的單詞,它們是有其特殊含義的。、
TODO: + 說明:
如果程式碼中有該標識,說明在標識處有功能程式碼待編寫,待實現的功能在說明中會簡略說明。
FIXME: + 說明:
如果程式碼中有該標識,說明標識處程式碼需要修正,甚至程式碼是錯誤的,不能工作,需要修復,如何修正會在說明中簡略說明。
XXX: + 說明:
如果程式碼中有該標識,說明標識處程式碼雖然實現了功能,但是實現的方法有待商榷,希望將來能改進,要改進的地方會在說明中簡略說明。
eclipse中特殊的註釋:
在eclipse中,TODO、FIXME和XXX都會被eclipse的task檢視所收集。在專案釋出前,檢查一下task檢視是一個很好的習慣。此外,在eclipse中,我們可自定義自己的特殊註釋標籤。如在C/C++中,進入window—>preferences—>C/C++—>Task Tags視窗即可新增特殊標籤,預設只有TODO、FIXME和XXX。
在Task視窗中有如下功能,點選就可以定位到指定的程式碼部分。比較方便。如圖:
相關文章
- Eclipse預設標籤TODO,XXX,FIXME和自定義標籤Eclipse
- 在程式碼註釋中,除了常見的 TODO、FIXME 和 XXX 外,還有哪些?
- C++中&和*的含義C++
- killall -HUP xxx含義是什麼
- Todo‑mvp‑clean 原始碼體驗MVP原始碼
- Laravel 原始碼筆記 框架目錄命名的含義Laravel原始碼筆記框架
- Java中static的含義Java
- TODO-MVP-RXJAVA 原始碼體驗MVPRxJava原始碼
- mysql中的編碼各個變數的含義MySql變數
- SMART原則的定義和含義
- Spring中bean的含義SpringBean
- oracle中斜槓(/)的含義Oracle
- SVN中clean up的含義
- 在Jetbrain IDE中自定義TODO功能AIIDE
- c++中&含義C++
- explain中filesort含義AI
- mysql 下的提示和含義MySql
- topas 中 PgSp 欄位的含義
- exists子句在Sql中的含義SQL
- JavaScript 中 void(0) 的含義JavaScript
- group by中cube含義解析
- async 函式的含義和用法函式
- Thunk 函式的含義和用法函式
- Linux shell中2>&1的含義Linux
- JS陣列中的apply含義JS陣列APP
- 聊聊“管理+IT”中管理的幾個含義
- 分析日記中的單詞的含義
- mysql explain用法和結果的含義MySqlAI
- co 函式庫的含義和用法函式
- 黑客的含義黑客
- ITL的含義
- Promise的含義Promise
- innobackupex中--slave-info引數的含義和適用場景
- spel和stream todo
- Mysql中備份資料檔案中/*!*/的含義MySql
- 伺服器託管中U的含義伺服器
- shell中變數$#,$@,$0,$1,$2的含義變數
- 執行計劃中cost, card的含義