代码中特殊的注释技术——TODO、FIXME和XXX的用处
2016-02-25 15:40
357 查看
前言:
今天在阅读Qt Creator的源代码时,发现一些注释中有FIXME英文单词,用英文词典居然查不到其意义!
实际上,在阅读一些开源代码时,我们常会碰到诸如:TODO、FIXME和XXX的单词,它们是有其特殊含义的。、
TODO: + 说明:
如果代码中有该标识,说明在标识处有功能代码待编写,待实现的功能在说明中会简略说明。
FIXME: + 说明:
如果代码中有该标识,说明标识处代码需要修正,甚至代码是错误的,不能工作,需要修复,如何修正会在说明中简略说明。
XXX: + 说明:
如果代码中有该标识,说明标识处代码虽然实现了功能,但是实现的方法有待商榷,希望将来能改进,要改进的地方会在说明中简略说明。
eclipse中特殊的注释:
在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: + 说明:
如果代码中有该标识,说明标识处代码虽然实现了功能,但是实现的方法有待商榷,希望将来能改进,要改进的地方会在说明中简略说明。
eclipse中特殊的注释:
在eclipse中,TODO、FIXME和XXX都会被eclipse的task视图所收集。在项目发布前,检查一下task视图是一个很好的习惯。此外,在eclipse中,我们可自定义自己的特殊注释标签。如在C/C++中,进入window—>preferences—>C/C++—>Task
Tags窗口即可添加特殊标签,默认只有TODO、FIXME和XXX。
相关文章推荐
- java项目中的几种bean对象
- ASP.Net如何用Cookies保存对象
- C++虚继承的概念
- cuda shared memory 静态分配和动态分配
- Java基础10 接口的继承与抽象类
- **meaven+springmvc 开发**
- ContentProvider是如何实现数据共享的。
- QT 对网址的解析和组合
- 面试题三 C/C++面试秘笈 查找单链表的中间元素 --程序员面试题
- [转]SSM框架——详细整合教程(Spring+SpringMVC+MyBatis)
- 10个基于 Ruby on Rails 构建的顶级站点
- Win10中安装eclipse
- 10个基于 Ruby on Rails 构建的顶级站点
- Qt Charts 2.1完全安装指南
- JavaEE之--------SpringMVC框架的搭建(注解实现)
- springMVC的url-pattern /和/*的区别
- spring整合hibernate完整版
- Java线程中run和start方法的区别
- Google Guava 类库 笔记
- 在Spring3中,配置DataSource的方法有6种