注册

一个简单的TODO,原来这么好用

平常我们再开发的时候,遇到一些想要之后去编写的部分,或者说再开发某个模块的时候,突然被事情打断,暂时无法实现的代码,以后才会去修复的bug的时候,要如何精准快速的去定位到那个位置呢?


下面来介绍一个很多人会忽律的标记TODO


TODO是一个特殊的标记,用于标识需要实现但目前还未实现的功能。这是一个Javadoc的标签,因此它只能应用于类、接口和方法。


它可以帮助我们跟踪和管理开发中的待办事项。


使用方法


首先看一个最基本的使用方法


@RestController
public class TestController {

@GetMapping("/hello")
public String hello(){
//TODO do something
return "Hello World";
}
}

这里我们加上TODO。之后再需要去进行修改的时候。


直接去搜索就可以了


image-20230906195743692


除了这个方法,还有很多隐藏的方法


进入设置


image-20230906195949934


这里就可以自定义todo了


如果是团队协作的话,每个人可以自定义其他的todo类型。


也可以用自己喜欢的更加醒目的颜色


image-20230906200230765


同时也可以在idea中进行全局的todo查看


image-20230906200444351


除了这个之外,还有过滤器,可以进行自定义的todo类型


image-20230906200527489


阿里巴巴Java开发手册中对TODO的规范标注主要有以下两点:



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

最佳实践


编写一个代码模板


image-20230906201219291


image-20230906201810835


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


作者:小u
来源:juejin.cn/post/7276696131113959458

0 个评论

要回复文章请先登录注册