在阅读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。
=====================另一篇======================================
在公司,今天的那个架构师讲了编程规范,学了一招还挺好用的。
就是关于//TODO 和//FIXME 的用法
//TODO表示还没做的事,就是还没写的代码。
//FIXME表示可能有些功能已经实现了但不是最好的,或者存在异常隐患,需要后面更改的。
在代码中使用这些可以指导你以后不会忘记了还没写的代码和需要更改的代码。MyEclipse中提供了这样的功能。
在Task窗口中有如下功能,点击就可以定位到指定的代码部分。比较方便。如图: