Java代码注释 XXX TODO FIXME 的意义
2014-11-20 09:59
253 查看
特殊注释:
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。
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 的意义
- Java代码注释XXX TODO FIXME 的意义
- Java代码注释XXX TODO FIXME 的意义
- Java代码注释XXX todo fixme
- Eclipse中Java代码注释XXX、TODO、FIXME的意义
- 代码中 TODO FIXME XXX 注释的特殊含义
- Eclipse中Java代码注释XXX、TODO、FIXME的意义
- Java代码注释XXX-todo-fixme-的意义
- Eclipse中Java代码注释XXX、TODO、FIXME的意义
- 代码中的TODO FIXME XXX 等注释释义
- Java代码注释XXX、TODO、FIXME的意义
- 代码中的TODO FIXME XXX 等注释释义
- Java_代码中特殊的注释技术——TODO、FIXME和XXX的用处
- 注释声明:TODO HACK XXX FIXME REVIEW
- Swift和OC代码注释分析 #pragma mark, FIXME and TODO
- eclipse中的特殊注释TODO FIXME XXX
- Swift和OC代码注释分析 #pragma mark, FIXME and TODO
- java 代码中的特殊注释 TODO 、 FIXME 、 XXX
- 代码中特殊的注释技术——TODO、FIXME和XXX的用处
- 代码中特殊的注释技术——TODO、FIXME和XXX的用处 (转载)