Java注释中TODO/FIXME/XXX的含义
Posted 街头浪子kevin
tags:
篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Java注释中TODO/FIXME/XXX的含义相关的知识,希望对你有一定的参考价值。
转自:http://free0007.iteye.com/blog/1886526
特殊注释:
1 TODO
表示需要实现,但目前还未实现的功能
2 XXX
勉强可以工作,但是性能差等原因
3 FIXME
代码是错误的,不能工作,需要修复
TODO: + 说明:
如果代码中有该标识,说明在标识处有功能代码待编写,待实现的功能在说明中会简略说明。
FIXME: + 说明:
如果代码中有该标识,说明标识处代码需要修正,甚至代码是错误的,不能工作,需要修复,如何修正会在说明中简略说明。
XXX: + 说明:
如果代码中有该标识,说明标识处代码虽然实现了功能,但是实现的方法有待商榷,希望将来能改进,要改进的地方会在说明中简略说明。
eclipse或myEclipse中特殊的注释:
在eclipse或myEclipse中,TODO、FIXME和XXX都会被eclipse的task视图所收集。在项目发布前,检查一下task视图是一个很好的习惯。此外,在eclipse中,我们可自定义自己的特殊注释标签。如在C/C++中,进入window—>preferences—>C/C++—>Task Tags窗口即可添加特殊标签,默认只有TODO、FIXME和XXX。
以上是关于Java注释中TODO/FIXME/XXX的含义的主要内容,如果未能解决你的问题,请参考以下文章
Android @Inject和@InjectView注释含义
请教Java SE高手一个简单的“@SuppressWarnings("unlikely-arg-type")”注释的含义是啥?