一个简单的TODO,原来这么好用

平常我们再开发的时候,遇到一些想要之后去编写的部分,或者说再开发某个模块的时候,突然被事情打断,暂时无法实现的代码,以后才会去修复的bug的时候,要如何精准快速的去定位到那个位置呢?

下面来介绍一个很多人会忽律的标记TODO

TODO是一个特殊的标记,用于标识需要实现但目前还未实现的功能。这是一个Javadoc的标签,因此它只能应用于类、接口和方法。

它可以帮助我们跟踪和管理开发中的待办事项。

使用方法

首先看一个最基本的使用方法

java 复制代码
@RestController
public class TestController {

    @GetMapping("/hello")
    public String hello(){
        //TODO do something
        return "Hello World";
    }
}

这里我们加上TODO。之后再需要去进行修改的时候。

直接去搜索就可以了

除了这个方法,还有很多隐藏的方法

进入设置

这里就可以自定义todo了

如果是团队协作的话,每个人可以自定义其他的todo类型。

也可以用自己喜欢的更加醒目的颜色

同时也可以在idea中进行全局的todo查看

除了这个之外,还有过滤器,可以进行自定义的todo类型

阿里巴巴Java开发手册中对TODO的规范标注主要有以下两点:

  1. TODO:表示需要实现,但目前还未实现的功能。这个标记通常用于类、接口和方法中。
  2. FIXME:标记某代码是错误的,而且不能工作,需要及时纠正的情况。

最佳实践

编写一个代码模板

这样,就是一个最佳的实战了。

相关推荐
子兮曰1 天前
jev-ultrafast 深度解析:7 秒订机票的浏览器 Agent 是如何炼成的
前端·后端·agent
小羊没烦恼!1 天前
微服务化的基石——持续集成
java·大数据·word·powerpoint·.net
子兮曰1 天前
Jev 爆发一周:7 秒 Agent 背后的 System One 生态与三场争议
前端·后端·ai编程
俊昭喜喜里1 天前
java中的继承和多态的区别
java
小羊没烦恼!1 天前
初探性能优化——2个月到4小时的性能提升
java·开发语言·windows·算法·c#
爱勇宝1 天前
ZCode 开源 24 小时:一份没有历史的账本,回答不了"有没有偷代码"
前端·后端·chatglm (智谱)
譕痕1 天前
JSONObject与JSONArray封装数据格式区别
java·json
胡写代码1 天前
别再前后端各写一套表单校验了
java·后端
小鱼能吃糖1 天前
缺陷修复总览 · mall电商项目:5类缺陷,1个病根,4个业务域
java·电商
此时不提桶,更待何时1 天前
01-06-A-JVM排查实战详解
java·jvm