代码中特殊的注释技术——TODO、FIXME和XXX的用处 (转载)
转自:http://blog.csdn.net/reille/article/details/7161942
作者:reille
本博客网址:http://blog.csdn.net/reille/,转载本博客原创文章请注明出处。
本文内容概要: 代码中特殊的注释技术——TODO、FIXME和XXX的用处。
更多请关注:http://velep.com/
———————————————————————————————————————————————————————————————————
前言:
今天在阅读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 linux book
- Tomcat 自动上传的删除文件
- Oracle Split Partitions
- 10.20_web编辑器复制粘贴图片
- [HeadFirst-JSPServlet学习笔记][第二章:高层概述]
- 【转】zookeeper 的监控工具
- spark sql 以JDBC为数据源
- 安卓推送——个推服务端api使用误区
- Excel报表开发(主要讲Excel的导入和导出)
- USB硬盘 raw之后,DiskGenius 恢复
- HDU6055 Regular polygon(计算几何)
- C语言中%d,%p,%u,%lu等都有什么用处
- BSA Network Shell系列-nexec | runcmd | runscript | scriptutil的异同
- GitHub学习笔记:远程端的操控
- 好的java资源地址
- Saltstack 集中化管理平台安装
- 【Spark调优】:如果实在要shuffle,使用map侧预聚合的算子
- springboot环境下配置过滤器和拦截器
- flask 处理表单数据
- Rails中activeAdmin的使用