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 BY-NC-SA 4.0 版权协议,转载请附上原文出处链接及本声明。
原文链接:https://www.renfei.net/posts/1003288
评论与留言
以下内容均由网友提交发布,版权与真实性无法查证,请自行辨别。

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


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

关注任霏博客
扫码关注「任霏博客」微信订阅号
微博:任霏博客网
Twitter:@renfeii
Facebook:任霏
最新留言 感谢🙏,第一个问题是空格的问题应该,我逐字敲完后可以构建了.第二个问题是我docker环境的问题,docker更新为最新版后需要重置配置文件.现已经正常使用,再次感谢您的分享和您的细心解答,期待下次相遇😄 还有一个问题可以请教下吗?就是我在容器里建文件夹没有权限,su root后密码不知道是多少,sudo mkdir xxx 提示我,没有sudo命令,请问有好的解决方法吗?谢谢解答 -v 后面可以指定文件吗 我的也是报错,还有。我执行了这个:@localhost kingbase-es-v8-r3-docker % docker run -d --name kingbase -p 54321:54321 -e SYSTEM_PWD=SYSTEM -v /opt/kingbase/data:/opt/kingbase/data -v /opt/kingbase:/opt/kingbase/Server/bin kingbase:v8r3 docker: 'run -d --name kingbase -p 54321:54321 -e SYSTEM_PWD=SYSTEM -v /opt/kingbase/data:/opt/kingbase/data -v /opt/kingbase:/opt/kingbase/Server/bin kingbase:v8r3' is not a docker command. See 'docker --help' 麻烦帮忙看下,是不是我写的命令有问题,还是版本问题,谢谢啦 请问我build的时候一直报错,是资源没了吗?failed to solve with frontend dockerfile.v0: failed to create LLB definition: failed to do request: Head "https://reg-mirror.qiniu.com/v2/library/centos/manifests/7?ns=docker.io": Moved Permanently 能不能在代码那里详细解释一下啊,没完全懂呀 en 按照路径上的来操作的,但是启动时一直报:zsh: no such file or directory: docker run -d --name kingbase -p 54321:54321 -e SYSTEM_PWD=SYSTEM -v /Volumes/installation/opt/kingbase/data:/opt/kingbase/data -v /Volumes/installation/opt/kingbase/bin/license.dat:/opt/kingbase/Server/bin/license.dat kingbase:v8r3 错误 博主,怎么没有spark入门教程? 亲测可用,十分感谢。 讲得好 我想提示博主,Adblock 广告屏蔽插件被启用提示这个弹窗非常不友好。它唯一的作用是影响用户阅读,甚至厌恶了离开。没有哪个用户会为了某一个站点而关闭防广告插件,因为这对于用户是不明智也不理智的,最终的伤害是贵站。