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

最佳实践

编写一个代码模板

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

相关推荐
Wang's Blog10 小时前
Java框架快速入门:深入MyBatis-Plus高级DML操作(ID策略·逻辑删除·乐观锁)
java·数据库·mybatis
程序员爱钓鱼10 小时前
Rust 数据类型详解:整数、浮点数、布尔、字符、元组和数组
后端·rust
KaMeidebaby10 小时前
卡梅德生物技术快报|噬菌体筛选:噬菌体筛选工程化优化方案:基于侵染全链条参数调控与水环境应用验证
java·开发语言·人工智能·机器学习·spark
geovindu10 小时前
go: Floyd-Warshall Algorithms
开发语言·后端·算法·golang
AC赳赳老秦11 小时前
Excel 动态仪表盘制作:用 OpenClaw 自动处理数据、生成交互式图表并实时更新仪表盘
大数据·服务器·后端·测试用例·excel·deepseek·openclaw
CoderYanger11 小时前
视频裁剪+缩放+自动添加水印脚本(Python版)
开发语言·后端·python·程序人生·职场和发展·音视频·学习方法
从零开始的代码生活_11 小时前
C++ 模板入门:函数模板、类模板与实例化机制
开发语言·c++·后端
我命由我1234519 小时前
Android Studio - Android Studio 自定义预览尺寸
android·java·ide·java-ee·android studio·android-studio·android runtime
mCell20 小时前
你以为短链接只是 Hash + 301/302?
后端·算法·架构
咖啡八杯20 小时前
GoF设计模式——迭代器模式
java·后端·设计模式·迭代器模式