豫ICP备17040950号-2

代码中的特殊注解 -- TODO、FIXME、XXX的作用

在阅读一些开源代码时,我们常会碰到诸如:TODO、FIXME和XXX的单词,它们是有其特殊含义的。

// TODO + 说明:
如果代码中有该注释,说明在该注释处有功能代码待编写,待实现的功能在说明中会简略说明。

// FIXME + 说明:
如果代码中有该注释,说明该注释处代码需要修正,甚至代码是错误的,不能工作,需要修复,如何修正会在说明中简略说明。
该处的注释在eclipse中的error tap中可以看到。

// XXX + 说明:
如果代码中有该注释,说明注释处代码虽然实现了功能,但是实现的方法有待商榷,希望将来能改进,要改进的地方会在说明中简略说明。

eclipse中特殊的注释:
在eclipse中,TODO、FIXME和XXX都会被eclipse的task视图所收集。在项目发布前,检查一下task视图是一个很好的习惯。