如何使用 TODO 注释

捏造的信仰

在所有的注释中,有两个关键字是做特殊用处的,它们是 TODOFIXME

TODO 的作用是将等下要做的事情先记下来。下面是一个例子:

比如我们要实现一个 greetings() 方法,但是我们手头上有其他的紧急任务,所以先暂时在这里写个注释,把要做的事情描述一下。

图片描述

为什么这个注释要以 TODO 开头呢?因为 IDE 会专门收集注释中的 TODOFIXME。我们可以打开 IDE 里面的 TODO 列表功能:

图片描述

图片描述

这样当我们有多个 TODO 注释分散在项目各处时,就可以在同一个地方看到了,这样一眼就看得出自己还有哪些事情没做完,非常方便。

所以当我们把这个事情做完的时候,要记得把对应的 TODO 注释删掉:

图片描述

这样它就不会出现在 TODO 列表里面了。

图片描述

同样的道理,FIXME 用于记录需要完善的代码部分,使用方法和 TODO 一样,这里就不赘述了。

阅读 6.7k

捏造的信仰
Java 开发人员

Java 开发人员

2.5k 声望
253 粉丝
0 条评论

Java 开发人员

2.5k 声望
253 粉丝
文章目录
宣传栏