一个简单的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 分钟前
基于Java+Maven+Testng+Selenium+Log4j+Allure+Jenkins搭建一个WebUI自动化框架(2)对框架加入业务逻辑层
java·selenium·maven
你的人类朋友1 小时前
🍃Kubernetes(k8s)核心概念一览
前端·后端·自动化运维
有没有没有重复的名字1 小时前
线程安全的单例模式与读者写者问题
java·开发语言·单例模式
追逐时光者2 小时前
面试第一步,先准备一份简洁、优雅的简历模板!
后端·面试
慕木兮人可2 小时前
Docker部署MySQL镜像
spring boot·后端·mysql·docker·ecs服务器
发粪的屎壳郎2 小时前
ASP.NET Core 8 轻松配置Serilog日志
后端·asp.net·serilog
程序员的世界你不懂2 小时前
基于Java+Maven+Testng+Selenium+Log4j+Allure+Jenkins搭建一个WebUI自动化框架(4)集成Allure报表
java·selenium·maven
isNotNullX3 小时前
数据中台架构解析:湖仓一体的实战设计
java·大数据·数据库·架构·spark
皮皮林5513 小时前
“RPC好,还是RESTful好?”,这个问题不简单
java
Xiaouuuuua3 小时前
一个简单的脚本,让pdf开启夜间模式
java·前端·pdf