一个简单的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:标记某代码是错误的,而且不能工作,需要及时纠正的情况。

最佳实践

编写一个代码模板

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

相关推荐
脑子慢且灵5 分钟前
【JavaWeb】一个简单的Web浏览服务程序
java·前端·后端·servlet·tomcat·web·javaee
用户2986985301421 分钟前
如何在 C# 中用表格替换 Word 文档中的文本?
后端
B612 little star king28 分钟前
力扣29. 两数相除题解
java·算法·leetcode
野犬寒鸦29 分钟前
力扣hot100:环形链表(快慢指针法)(141)
java·数据结构·算法·leetcode·面试·职场和发展
上官浩仁34 分钟前
springboot synchronized 本地锁入门与实战
java·spring boot·spring
Gogo81635 分钟前
java与node.js对比
java·node.js
SmartJavaAI41 分钟前
Java调用Whisper和Vosk语音识别(ASR)模型,实现高效实时语音识别(附源码)
java·人工智能·whisper·语音识别
山东小木44 分钟前
JBoltAI需求分析大师:基于SpringBoot的大模型智能需求文档生成解决方案
人工智能·spring boot·后端·需求分析·jboltai·javaai·aigs
用户3721574261351 小时前
Python 高效实现 Word 转 PDF:告别 Office 依赖
java
渣哥1 小时前
Java ThreadPoolExecutor 动态调整核心线程数:方法与注意事项
java