博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
代码中特殊的注释技术——TODO、FIXME和XXX的用处
阅读量:6072 次
发布时间:2019-06-20

本文共 561 字,大约阅读时间需要 1 分钟。

转载自:http://www.cnblogs.com/pengyingh/articles/2445826.html

 

前言:

今天在阅读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。

 

你可能感兴趣的文章
前端优化总结
查看>>
HDFS01
查看>>
SQL 是什么?
查看>>
基于DDD的.NET开发框架 - ABP的Entity设计思想
查看>>
IOS静态库和Framework区别
查看>>
安装 Dynamics AX 2012 Data Migration Framework
查看>>
BZOJ4902【CTSC2017】游戏
查看>>
处处连续处处不可微
查看>>
【补充习题四】凑微分技巧与积分因子法解常微分方程
查看>>
时间复杂度
查看>>
java实现图片压缩
查看>>
[BZOJ 1968] [AHOI 2005] 约数研究
查看>>
BitCoin p2p通信过程
查看>>
C++ 标准IO库
查看>>
MySql.Data.dll的版本
查看>>
JS判断对象是否存在
查看>>
实验四:主存空间的分配和回收
查看>>
P1026 犁田机器人
查看>>
JSP页面和属性命名规范
查看>>
mysql命令行修改字符编码
查看>>