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

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

首页角色扮演代号ME更新时间:2024-04-29

TODO、FIXME注释

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

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

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

TODO:需要去做的事

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

TODO未解决提示

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

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

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

查看全文
大家还看了
也许喜欢
更多游戏

Copyright © 2024 妖气游戏网 www.17u1u.com All Rights Reserved