2019-09-17 18:43:48

在写代码中的小技巧:使用 TODO、FIXME 来记录备忘事项


在写代码中的小技巧:使用 TODO、FIXME 来记录备忘事项

我们每天Coding都会面临思路被迫中断,或者今天下班明天继续的情况,如果什么也不做,可能我们就想不起来还要干什么事,甚至解决问题的思路也一去不复返了。

有没有解决办法呢?其实这个问题早就已经被解决了,现在的大部分IDE开发环境都支持备忘注释,最常见的是TODO、FIXME,有的还有 XXX、HACK,本次先介绍 TODO和FIXME:

//TODO 还需要做一些事
//FIXME 此处有个问题需要修复

TODO:需要去做的事

这个注解按照字面的意思应该就能理解了,是还需要做一些事情,这样我们就能快速的拉回自己的思路,回忆起当时写代码时候的情景,同时IDE在提交Git的时候,还会帮我们进行检查,如果你的代码中包含TODO注解,就会给你提示,是不是还有没完成的工作?有效避免了我们时间长忘记补全功能代码。

FIXME:这里有错误,需要解决

这个注解的意思是这里有错误需要解决,也许这段代码不是你写的,但是你告诉你的团队成员又怕他忘了,你这时候就可以使用FIXME注解,标记出来,这里有错误,大概是怎么回事,这样队友那边就不会忘了。


使用这两个注释对我的帮助很大,十分有效的帮助我回到昨天的思路和进度,不知道你使用了没?


版权声明:本文为博主「任霏」原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接及本声明。
原文链接:https://www.renfei.net/posts/1003288
评论与留言
以下内容均由网友提交发布,版权与真实性无法查证,请自行辨别。

本站有缓存策略,时间约2小时后能看到您的评论。本站使用自动审核机制,如果您的内容包含广告/谩骂/恐怖/暴力/涉政等不和谐内容将无法展示!


本站有缓存策略,时间约2小时后能看到您的评论。本站使用自动审核机制,如果您的内容包含广告/谩骂/恐怖/暴力/涉政等不和谐内容将无法展示!

关注任霏博客
扫码关注「任霏博客」微信订阅号
微博:任霏博客网
Twitter:@renfeii
Facebook:任霏