zoukankan      html  css  js  c++  java
  • Java代码注释XXX TODO FIXME 的意义

    特殊注释:

    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。

  • 相关阅读:
    一、异常
    自控力_第三章
    Vocabulary Recitation 2020/05/05
    Vocabulary Recitation 2020/05/04
    Vocabulary Recitaion 2020/05/03
    Vocabulary Recitation 2020/05/01
    最大子序列和
    Vocabulary Recitation 2020/04/29
    自控力_第二章
    Vocabulary Recitation 2020/04/27
  • 原文地址:https://www.cnblogs.com/chaizp/p/5217359.html
Copyright © 2011-2022 走看看