【开发工具】IntelliJ IDEA TODO功能使用

没有人挡得住,你疯狂的努力进取。你可以不够强大,但你不能没有梦想。如果你没有梦想,你只能为别人的梦想打工筑路。

导读:本篇文章讲解 【开发工具】IntelliJ IDEA TODO功能使用,希望对大家有帮助,欢迎收藏,转发!站点地址:www.bmabk.com,来源:原文

背景

遇到一些功能方法暂时没有时间实现的或者是一些问题待解决的,可以使用TODO标签来标识这些地方,下次通过idea查找TODO标签窗口,可以快速查询到当前项目工程中需要解决TODO的问题

编写一个TODO

TODO就是普通的 // 注解添加一个TODO标识,目的是很快找到这个注解的代码,提高开发效率

// TODO 这个接口需要调试

在这里插入图片描述

步骤1

使用idea打开一个已有的项目工程代码,如果没有的话,可以时间新建一个最简单和普通的java项目工程即可,在工具类最下方点击TODO窗口,可以查看当前所有的项目代码中标识的TODO标签
在这里插入图片描述

步骤2

通过这个窗口,可以很直观的查询到当前项目中哪些类存在之前标识的TODO标签,选择其中一个类的TOTO标签记录,双击即可快速定位到那个类的标签位置

在这里插入图片描述

步骤3

如果一个类中有多个TODO标签,则按照如图所示的红色框切换到Current File,可以在当前文件中显示所有的TODO标签
在这里插入图片描述

步骤4

项目中如果代码标记的TODO比较多的话,查询起来显示的记录也会很多,不利于查看,可以选择一个合适的查询范围,点击“Scope Based”,选择一个较小的搜索范围,可以有效查询到需要的TODO标签
在这里插入图片描述

合理的使用TODO标签可以更为方便的编写代码,防止遗漏未实现或未解决的问题

补充:如何快速查看自己的todo标签

步骤1、File–>settings–>todo

配置自己的todo标签 正则表达
在这里插入图片描述
在这里插入图片描述
输入:\btodo-zhw\b.*

步骤2、自定义自己的todo标签名称,用于以后检索

在这里插入图片描述

步骤3、配置todo快捷键模板

IDEA类和方法注释模板设置

效果:

在这里插入图片描述

在这里插入图片描述

步骤4、检索自己的todo标签

在这里插入图片描述
在这里插入图片描述

这是阿里巴巴手册中关于TODO 标记的编写指南 【参考】特殊注释标记,请注明标记人与标记时间。注意及时处理这些标记,通过标记扫描,
经常清理此类标记。线上故障有时候就是来源于这些标记处的代码。

1) 待办事宜(TODO):( 标记人,标记时间,[预计处理时间]) 表示需要实现,但目前还未实现的功能。 这实际上是一个 Javadoc
的标签,目前的 Javadoc 还没有实现,但已经被广泛使用。只能应用于类,接口和方法(因为它是一个 Javadoc 标签)。

2) 错误,不能工作(FIXME):(标记人,标记时间,[预计处理时间]) 在注释中用 FIXME
标记某代码是错误的,而且不能工作,需要及时纠正的情况

总结

遇到一些功能方法暂时没有时间实现的或者是一些问题待解决的,可以使用TODO标签来标识这些地方,下次通过idea查找TODO标签窗口,可以快速查询到当前项目工程中需要解决TODO的问题,提高工作效率。

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。

文章由半码博客整理,本文链接:https://www.bmabk.com/index.php/post/132139.html

(0)
飞熊的头像飞熊bm

相关推荐

发表回复

登录后才能评论
半码博客——专业性很强的中文编程技术网站,欢迎收藏到浏览器,订阅我们!