关于几种编程过程中的注释(TODO、FIXME、XXX等)
最近看别人写的代码,注意到很多规范的代码的注释写的都特别好。只是不太明白TODO、FIXME这些事什么意思。查阅资料,看到一篇博客,遂转载而来,以供今后查阅。
(转载地址http://www.cnblogs.com/pengyingh/articles/2445826.html)
TODO:说明在标识处有功能代码待编写,待实现的功能在说明中会简略说明。
FIXME:说明标识处代码需要修正,甚至代码是错误的,不能工作,需要修复,如何修正会在说明中简略说明。
XXX:说明标识处代码虽然实现了功能,但是实现的方法有待商榷,希望将来能改进,要改进的地方会在说明中简略说明。
eclipse中特殊的注释:
在eclipse中,TODO、FIXME和XXX都会被eclipse的task视图所收集。在项目发布前,检查一下task视图是一个很好的习惯。此外,在eclipse中,我们可自定义自己的特殊注释标签。如在C/C++中,进入window->preferences->C/C++->Task Tags窗口即可添加特殊标签,默认只有TODO、FIXME和XXX。(注:eclipse这段纯属摘抄,未验证,因为暂时使用的.net)