IDEA自定义TODO注释

原创
2018/08/31 11:19
阅读数 1.9W

由于自己写的代码依赖其他人的接口,但是其他人未完成开发。

我自己调用了几个新申明的一些空的方法,等其他人完成我需要的接口后,在这些空方法中实现对他人接口的调用。怕将来忘记实现所以在方法体中添加如下注释

//TODO 调用XXX接口,查询XXXX

以后在IDEA的底部点击TODO面板可以看到:

由于使用分布式服务,很多子工程,更有海量的其他人标记的TODO注释,还有一些逆向工程生成代码中注释也有TODO。时间长了哪里还记得哪个是自己留下的TODO注释。也有个笨办法就是在TODO 的内容中增加自己的姓名,全局搜索可以找到,就如 “某某某到此一游” 之后全局查询,感觉很low。

重点来了,怎么可以快速的找到自己标注的TODO,而不被别人的干扰呢?下面就要仔细看了。

这里有一个好办法就是点击TODO面板左面的过滤器图标:

点击编辑过滤器,也就是 Edit Filters

出现的窗口分上下两部分,上面是 标签模式  下面是 过滤器

先在上面点击绿色+号

出现如下对话框:

在模式中写入 类似上面的内容:\btodo-yh\b.*

说明 \bxxxx\b.*  其中xxxx 就是你要定义的标签名称,我这里是todo-yh(大小写均可),意思是 颖辉的todo。

下面下拉表示自定义注释的图标,一共三个可选。

然后是大小写铭感,不建议勾选。

最后一个是自定义注释的颜色方案,默认使用TODO一样的,也可以自己修改颜色。

点击确定,一个自己定的标签就算定义好了。

代码中使用这个 //TODO-yh,看看效果:

很不错吧,这只是自定义了一个注释的模式,下面告诉你怎么可以快速的找到你自定义的TODO注释。

继续点击上面提到的过滤器图标,再点编辑过滤器

这回注意下面,点击+,添加过滤器

填入自定义过滤器名称 todo-yh(可以改成别的),选择刚刚添加的自定义的模式\btodo-yh\b.*,确定关闭上面的对话框。再点击确定,关闭编辑过滤器的对话框。

TODO下选择Project或者Scope Based子面板。

点击过滤器图标

发现多了一个 todo-yh 的选项,点击它。

TODO中看到的都是你使用的 //TODO-yh 注释了。

结合

三项可以以不同的方式显示,比如按照modules分组,按照包分组等。

大功告成!喜欢这篇文章请点个赞,或者留言,不胜感激。

 

 

 

 

 

展开阅读全文
加载中
点击引领话题📣 发布并加入讨论🔥
打赏
0 评论
1 收藏
2
分享
返回顶部
顶部