1. 程式人生 > >為Source Insight新增TODO、FIXME等註釋標籤的高亮

為Source Insight新增TODO、FIXME等註釋標籤的高亮

在程式中加入TODO、FIXME等特殊的註釋標籤有助於提高程式碼編寫效率,特別是多人協作的情況下。一般用法如下:

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

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

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

Source Insight中,對註釋標籤有有限的支援,通過新增自定義樣式,可以擴充套件註釋標籤的種類。效果圖如下:
這裡寫圖片描述

方法如下:
1. 新增自定義樣式
點選Options - Style Properties,選中左欄中Comment分類下的Comment To Do,點選Add Style。在彈出視窗中設定命名,如“Comment Fix Me”。設定其風格, 可更改Background顏色,其他設定已保持與Comment To Do一致即可。建議根據不同顏色區分各標籤的重要程度。
2. 新增語言解析
點選Options - Performance,選擇Language選項卡,雙擊需要設定的語言,在Comment and Ranges選項卡下點選Add,如圖
這裡寫圖片描述
在Syntax Formatting Style一欄中選擇剛才新增的樣式,在Range begins with中填入該註釋標籤的起始標誌,如“// FIXME:”。
3. 使用
在程式碼註釋前加入“ FIXME:”字樣即可使該行註釋高亮,注意“FIXME”前有一空格。

圖中的“TODO”和兩行帶下劃線的“標題”註釋是Source Insight自帶的,用法分別是“// TODO:”和“//1 ”注意,“TODO”前和“1”後有空格。這兩種樣式可以自動隱藏“//”,自定樣式如何實現暫時還不知道如何實現。