如何使用 TODO 注释

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

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

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

图片描述

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

图片描述

图片描述

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

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

图片描述

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

图片描述

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

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值