代码中三种特殊注释——TODO、FIXME、XXX

在eclipse中,TODO、FIXME和XXX都会被eclipse的task视图所收集。在项目发布前,检查一下task视图是一个很好的习惯。进入window→show view→Other→输入tasks然后open就可以看到了。

//TODO + 说明:

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

 

// FIXME + 说明:

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

该处的注释在eclipse中的error tap中可以看到。

 

// XXX + 说明:

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

 

eclipse中特殊的注释:

此外,在eclipse中,我们可自定义自己的特殊注释标签。设置方法:进入Window → Preferences → General → Editors → Structured Text Editors → Task Tags窗口即可添加特殊标签,默认只有TODO、FIXME和XXX。

进入Window→ Preferences→ Java→ Compiler→ Task Tags窗口,也可以设置自定义标签。

posted @ 2018-07-24 19:40  章三丰  阅读(1370)  评论(0编辑  收藏  举报