TODO有什么妙用

本文涉及的产品
云数据库 RDS MySQL,集群系列 2核4GB
推荐场景:
搭建个人博客
RDS MySQL Serverless 基础系列,0.5-2RCU 50GB
云数据库 Tair(兼容Redis),内存型 2GB
简介: `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:标记某代码是错误的,而且不能工作,需要及时纠正的情况。

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

相关文章
|
Java 编译器
【JavaSE专栏66】使用instanceof关键字,验证显隐式类型转换
【JavaSE专栏66】使用instanceof关键字,验证显隐式类型转换
|
前端开发 JavaScript API
📕重学JavaScript:Promise 的then()、catch() 和 finally()
大部分时候,你要用的 Promise 对象是 Web API 或第三方 API 返回的。我们要设置 Promise 对象,让它在变成 fulfilled 的时候执行我们想要的成功的代码,而在变成 rejected 的时候执行我们想要的失败的代码。
390 0
📕重学JavaScript:Promise 的then()、catch() 和 finally()
|
JavaScript 前端开发
📕 重学JavaScript:如何实现一个`call`/`apply`?
这次要说的 call/apply 方法其实和 bind 极其类似。
84 0
|
应用服务中间件 Apache nginx
Yii框架中的'enablePrettyUrl' => true, 这段代码是干什么的?底层原理是什么?为什么这样写?
Yii框架中的'enablePrettyUrl' => true, 这段代码是干什么的?底层原理是什么?为什么这样写?
163 0
|
前端开发
前端hook项目moblie总结笔记-三元运算符进行判断
前端hook项目moblie总结笔记-三元运算符进行判断
67 0
|
存储 移动开发 JavaScript
学习todo-list源码📒 真的学会了很多开发实践!
学习todo-list源码📒 真的学会了很多开发实践!
354 0
|
Go 开发者
switch使用细节(2)|学习笔记
快速学习switch使用细节(2)
|
编译器 Go 开发者
switch使用细节(1)|学习笔记
快速学习switch使用细节(1)
|
JavaScript
分不清bind、apply、call?手写实现一下就明白了
bind、call和apply都是`Function`原型链上面的方法,因此不管是使用`function`声明的函数,还是箭头函数都可以直接调用。这三个函数在使用时都可以改变`this`指向,本文就带你看看如何实现bind、call和apply。
126 0
分不清bind、apply、call?手写实现一下就明白了
|
Java 索引 Spring
小小TODO标识,你用对了吗?
小小TODO标识,你用对了吗?
小小TODO标识,你用对了吗?