TODO有什么妙用

本文涉及的产品
RDS MySQL Serverless 基础系列,0.5-2RCU 50GB
云数据库 Redis 版,标准版 2GB
推荐场景:
搭建游戏排行榜
云数据库 RDS MySQL,集群系列 2核4GB
推荐场景:
搭建个人博客
简介: `TODO` 是Java开发中用于标记未完成功能或待修复问题的注解,能帮助追踪和管理开发任务。在代码中添加 `// TODO` 标记,如 `// TODO do something`,之后可通过搜索快速定位。IDEA还支持自定义`TODO`类型和颜色,以及全局查看和过滤器功能。阿里巴巴开发手册建议使用 `TODO` 表示待实现功能,`FIXME` 标记错误代码。推荐创建个性化代码模板以提高效率。

平常我们再开发的时候,遇到一些想要之后去编写的部分,或者说再开发某个模块的时候,突然被事情打断,暂时无法实现的代码,以后才会去修复的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的规范标注主要有以下两点:

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

最佳实践
编写一个代码模板

相关文章
|
12月前
|
Web App开发 前端开发 JavaScript
答网友提问:为什么语句 var oModel = this.stub() 是构造一个stub对象? stub()是一个函数,从哪里来的?
答网友提问:为什么语句 var oModel = this.stub() 是构造一个stub对象? stub()是一个函数,从哪里来的?
|
4月前
|
存储 安全 编译器
【C++】基础知识讲解(引用、内联、auto,基于范围for循环)
【C++】基础知识讲解(引用、内联、auto,基于范围for循环)
33 1
|
存储 移动开发 JavaScript
学习todo-list源码📒 真的学会了很多开发实践!
学习todo-list源码📒 真的学会了很多开发实践!
327 0
|
文字识别 小程序 前端开发
【小程序自动化Minium】二、元素定位-Page接口中的 get_element() 与 get_elements()
【小程序自动化Minium】二、元素定位-Page接口中的 get_element() 与 get_elements()
【小程序自动化Minium】二、元素定位-Page接口中的 get_element() 与 get_elements()
|
JavaScript 小程序 Java
妙用Java8中的“Function”消灭if...else!
妙用Java8中的“Function”消灭if...else!
妙用Java8中的“Function”消灭if...else!
|
算法 Java Linux
难怪我看不懂!call_stub竟然这么玄乎!
哈喽,我是子牙。十余年技术生涯,一路披荆斩棘从技术小白到技术总监到JVM专家到创业。技术栈如汇编、C语言、C++、Windows内核、Linux内核。特别喜欢研究虚拟机底层实现,对JVM有深入研究。分享的文章偏硬核,很硬的那种。
135 0
难怪我看不懂!call_stub竟然这么玄乎!
妙用 Java 8 中的 Function 接口,消灭 if...else(非常新颖的写法)(上)
妙用 Java 8 中的 Function 接口,消灭 if...else(非常新颖的写法)(上)
155 0
妙用 Java 8 中的 Function 接口,消灭 if...else(非常新颖的写法)(上)
妙用 Java 8 中的 Function 接口,消灭 if...else(非常新颖的写法)(下)
妙用 Java 8 中的 Function 接口,消灭 if...else(非常新颖的写法)(下)
131 0
妙用 Java 8 中的 Function 接口,消灭 if...else(非常新颖的写法)(下)
|
编译器
新年第一问,请解释一下extend和super泛型中list操作的区别?
新年第一问,请解释一下extend和super泛型中list操作的区别?
89 0
|
Java 索引 Spring
小小TODO标识,你用对了吗?
小小TODO标识,你用对了吗?
小小TODO标识,你用对了吗?