美文网首页
Java代码注释XXX todo fixme 的意义

Java代码注释XXX todo fixme 的意义

作者: 低至一折起 | 来源:发表于2017-12-05 19:59 被阅读0次

特殊注释:

  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。

相关文章

网友评论

      本文标题:Java代码注释XXX todo fixme 的意义

      本文链接:https://www.haomeiwen.com/subject/hmxhixtx.html