代码中特殊的注释技术——TODO、FIXME和XXX的用处（转）

1、声明

本篇转自博客：http://blog.csdn.net/reille/

 

2、转载内容

2.1、前言

今天在阅读 Qt Creator 的源代码时，发现一些注释中有 FIXME 英文单词，用英文词典居然查不到其意义！
实际上，在阅读一些开源代码时，我们常会碰到诸如：TODO、FIXME 和 XXX 的单词，它们是有其特殊含义的

 

2.2、TODO: + 说明：

如果代码中有该标识，说明在标识处有功能代码待编写，待实现的功能在说明中会简略说明。

2.3、FIXME: + 说明：

如果代码中有该标识，说明标识处代码需要修正，甚至代码是错误的，不能工作，需要修复，如何修正会在说明中简略说明。

2.4、XXX: + 说明：

如果代码中有该标识，说明标识处代码虽然实现了功能，但是实现的方法有待商榷，希望将来能改进，要改进的地方会在说明中简略说明。

2.5、eclipse 中特殊的注释：

在 eclipse 中，TODO、FIXME 和 XXX 都会被 eclipse 的 task 视图所收集。

在项目发布前，检查一下task视图是一个很好的习惯。

此外，在 eclipse 中，我们可自定义自己的特殊注释标签。

如在 C/C++中，进入window —> preferences —> C/C++ —>Task Tags 窗口即可添加特殊标签，默认只有 TODO、FIXME 和 XXX 。

 

3、最后

对于自己写的不太确定的部分，并且眼下又没有人来参与讨论，那么，可以用 XXX 的形式来标注，并且写一下当时的思路注解，这样上线前，检查一下，就不会因为忘记而造成一些不必要的麻烦。