首页 > 技术文章 > Java代码注释TODO FIXME XXX的意义

veins 2014-05-22 14:51 原文

特殊注释:

1 TODO

表示需要实现,但目前还未实现的功能

2 XXX

勉强可以工作,但是性能差等原因

3 FIXME

代码是错误的,不能工作,需要修复

 

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

FIXME: + 说明
如果代码中有该标识,说明标识处代码需要修正,甚至代码是错误的,不能工作,需要修复,如何修正会在说明中简略说明。

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

eclipse中特殊的注释:
在eclipse中,TODO、FIXME和XXX都会被eclipse的task视图所收集。在项目发布前,检查一下task视图是一个很好的习惯。此外,在eclipse中,我们可自定义自己的特殊注释标签。如在C/C++中,进入window—>preferences—>C/C++—>Task Tags窗口即可添加特殊标签,默认只有TODO、FIXME和XXX。

 

原文:http://free0007.iteye.com/blog/1886526

 

---------------------------------------------------------------------------------------------------------------------------------

“TODO”任务链接创建

  Eclipse可以提醒您仍需执行的任务。许多开发人员在代码中添加TODO注释来提醒他们还有特定的任务要完成,或者特定的情况要处理。Eclipse又一次利用它对Java结构的知识找到任何以TODO开头的注释,并将它添加到一个特殊的Tasks视图(打开Window > Show View > Other > General > Tasks就可看到)。这样,Eclipse可以提供一个全面的待完成的任务列表。

  此外,您还可以配置Eclipse去识别您定义的其他标签。打开Preferences(Window Menu > Preferences)并浏览到“Task Tags”页面(Java > Task Tags)。您就可以添加新标签,删除已有标签,设置不同标签的属性,为代码指定Eclipse提供的默认值。

推荐阅读