代码中特殊的注释技术——TODO、FIXME和XXX的用处
来源:互联网 发布:c语言中数组的定义 编辑:程序博客网 时间:2024/05/17 08: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的用处
- R语言介绍与安装
- jquery $(document).ready() 与window.onload的区别
- DBCC大全集之(适用版本MS SQLServer 2008 R2)---DBCC CHECKFILEGROUP检查当前数据库中指定文件组中的所有表和索引视图的分配和结构完整性
- arm-linux-gcc交叉编译环境的搭建
- CreateThread函数原型
- 代码中特殊的注释技术——TODO、FIXME和XXX的用处
- SIP PRACK
- Linux学习之——存储设备和分区标识及分区
- List for springRestful + openlayer
- DBCC大全集之(适用版本MS SQLServer 2008 R2)---DBCC CHECKFILEGROUP检查当前数据库中指定文件组中的所有表和索引视图的分配和结构完整性
- 关于android的JNI几点注意问题。
- 驱动开发之三:常用API简介
- GStreamer iOS教程4——一个基础的播放器
- [TED] 创建自己的ramfs (二)