为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”后有空格。这两种样式可以自动隐藏“//”,自定样式如何实现暂时还不知道如何实现。