一个简单的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 分钟前
基于Flask框架实现的一个在线考试系统
后端·python·flask
ArabySide6 分钟前
【Java】重构之善用多态解耦,记录一次模板方法实践
java·重构·模板方法模式
wanghowie12 分钟前
01.03 Java基础篇|面向对象核心与设计实践
java·开发语言
vortex517 分钟前
ORM是什么?如何理解ORM?ORM的优缺点?
java·数据库·sql·mysql·oracle·orm
Algebraaaaa19 分钟前
为什么线程阻塞要用.join而不是.wait
java·c++·python
王中阳Go20 分钟前
12 Go Eino AI应用开发实战 | 消息队列架构
人工智能·后端·go
是苏浙23 分钟前
零基础入门Java之设计图书管理系统
java·开发语言
墨雪不会编程29 分钟前
C++内存管理深度剖析
java·开发语言·c++
BBB努力学习程序设计32 分钟前
Java Scanner完全指南:让程序与用户对话
java
BBB努力学习程序设计35 分钟前
Java面向对象编程:封装、继承与多态深度解析
java