代码中特殊的注释技术——TODO、FIXME和XXX的用处

今天在阅读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。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值