Java_代码中特殊的注释技术——TODO、FIXME和XXX的用处
来源:互联网 发布:js延迟一秒 编辑:程序博客网 时间:2024/05/16 03:50
前言:
今天在阅读Qt Creator的源代码时,发现一些注释中有FIXME英文单词,用英文词典居然查不到其意义!
实际上,在阅读一些开源代码时,我们常会碰到诸如:TODO、FIXME和XXX的单词,它们是有其特殊含义的。、
TODO: + 说明:
如果代码中有该标识,说明在标识处有功能代码待编写,待实现的功能在说明中会简略说明。
FIXME: + 说明:
如果代码中有该标识,说明标识处代码需要修正,甚至代码是错误的,不能工作,需要修复,如何修正会在说明中简略说明。
XXX: + 说明:
如果代码中有该标识,说明标识处代码虽然实现了功能,但是实现的方法有待商榷,希望将来能改进,要改进的地方会在说明中简略说明。
MyEclipse中特殊的注释:
在eclipse中,TODO、FIXME和XXX都会被eclipse的task视图所收集。在项目发布前,检查一下task视图是一个很好的习惯。此外,在eclipse中,我们可自定义自己的特殊注释标签。如在C/C++中,进入window—>preferences—>C/C++—>Task Tags窗口即可添加特殊标签,默认只有TODO、FIXME和XXX。
今天在阅读Qt Creator的源代码时,发现一些注释中有FIXME英文单词,用英文词典居然查不到其意义!
实际上,在阅读一些开源代码时,我们常会碰到诸如:TODO、FIXME和XXX的单词,它们是有其特殊含义的。、
TODO: + 说明:
如果代码中有该标识,说明在标识处有功能代码待编写,待实现的功能在说明中会简略说明。
FIXME: + 说明:
如果代码中有该标识,说明标识处代码需要修正,甚至代码是错误的,不能工作,需要修复,如何修正会在说明中简略说明。
XXX: + 说明:
如果代码中有该标识,说明标识处代码虽然实现了功能,但是实现的方法有待商榷,希望将来能改进,要改进的地方会在说明中简略说明。
MyEclipse中特殊的注释:
在eclipse中,TODO、FIXME和XXX都会被eclipse的task视图所收集。在项目发布前,检查一下task视图是一个很好的习惯。此外,在eclipse中,我们可自定义自己的特殊注释标签。如在C/C++中,进入window—>preferences—>C/C++—>Task Tags窗口即可添加特殊标签,默认只有TODO、FIXME和XXX。
阅读全文
0 0
- Java_代码中特殊的注释技术——TODO、FIXME和XXX的用处
- 代码中特殊的注释技术——TODO、FIXME和XXX的用处
- 代码中特殊的注释技术——TODO、FIXME和XXX的用处
- 代码中特殊的注释技术——TODO、FIXME和XXX的用处
- 代码中特殊的注释技术——TODO、FIXME和XXX的用处
- 代码中特殊的注释技术——TODO、FIXME和XXX的用处
- 代码中特殊的注释技术——TODO、FIXME和XXX的用处
- 代码中特殊的注释技术——TODO、FIXME和XXX的用处
- 代码中特殊的注释技术——TODO、FIXME和XXX的用处
- 代码中特殊的注释技术——TODO、FIXME和XXX的用处
- 代码中特殊的注释技术——TODO、FIXME和XXX的用处
- 代码中特殊的注释技术——TODO、FIXME和XXX的用处
- 代码中特殊的注释技术——TODO、FIXME和XXX的用处
- 代码中特殊的注释技术——TODO、FIXME和XXX的用处
- 代码中特殊的注释技术——TODO、FIXME和XXX的用处
- 代码中特殊的注释技术——TODO、FIXME和XXX的用处
- 代码中特殊的注释技术——TODO、FIXME和XXX的用处。
- 代码中特殊的注释技术——TODO、FIXME和XXX的用处
- PL/SQL Developer查询结果中文乱码???
- 在ATM2时遇到的问题
- linux解决依赖性问题
- 开源PLog库的使用
- INSTALL_FAILED_UPDATE_INCOMPATIBLE解决
- Java_代码中特殊的注释技术——TODO、FIXME和XXX的用处
- 2017.6.11
- 《数论概论》读书笔记 第6章 线性方程与最大公约数
- 《数据结构学习与实验指导》3-8:堆栈模拟队列
- Material Design系列--CollapsingToolbarLayout使用总结
- 1102 Constructing Roads(并查集)
- First Blood
- 2017年网易校招算法编程题:数论 (PHP版)
- Linux运维CentOS系统SVN双备份Shell脚本