代码中特殊的注释技术——TODO、FIXME和XXX的用处
来源:互联网 发布:mac 大文件上传 编辑:程序博客网 时间:2024/06/09 18:59
前言:
今天在阅读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。
0 0
- 代码中特殊的注释技术——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的用处
- H264码流结构分析和rtp打包结构详解
- ubuntu13.10搭建nfs及通过fstab支持mount远程目录
- nw.js node-webkit系列(8)Native UI API MenuItem的使用
- Toast工具
- 【POJ 2777】 Count Color(线段树区间更新与查询)
- 代码中特殊的注释技术——TODO、FIXME和XXX的用处
- dblp 介绍 使用,计算机领域内对研究的成果以作者为核心的一个计算机类英文文献的集成数据库系统
- c++服务端用webservices【gsoap】做服务端与java后台对接信息的测试工具
- JSONP跨域GET请求
- 创建pch文件
- Android之线程池深度剖析
- 实现图片水平滑动1(利用HorizontalScrollView)
- iOS sizeClass设备对照表
- Oracle数据库版本定期检视与升级的必要性分析