JAVA的任务标记
JAVA的任务标记有助于我们在整个项目中标记出需要注意(说明、待处理、自定义功能)的代码块。常用的预定义标记有:
- todo: 表示改段代码的将要实现的功能说明,多用于项目代码的预构造中。
- fixme:表示此处代码存在问题或者不可使用,需要检查修复。
在idea中,可以通过todo窗口查看到任务标识,效果如下图:
除了常用的预定义标识外,我们还可以自定义一些任务标识以做其他用途,如my notes(用于学习开源项目的源码中做自己的笔记)、其他用于项目团队中自定义的任务标识。
JAVA的任务标记在idea中的设置
idea的预定义任务标识
在Performance->Editor->Todo中,我们可以看到idea已经预先定义了todo和fixme关键字的任务表示:
可以看到,预先定义的任务标识是以todo或者fixme为关键字,且不区分大小写字母的定义。此处可以修改显示格式等其他信息,实际上我们不需要修改此处的预定义标识。
自定义任务标识
在上面的设置界面,在Patterns框中点击“+”标记,添加自定义的任务标识,如下图定义my notes任务标识:
如上图,我定义了关键字:“my notes”,不区分大小写,icon图标修改为叹号以突出显示,定义了紫色的字体颜色以与todo标识区分。其中Pattern中填入的是idea的常规表达式,详细说明参考其官网说明:Regular expression syntax reference。在idea中的效果如下图:
任务标识过滤器
但是在个别情况中,由于所有的任务标识都在todo窗口检索到,一些大的项目会出现混乱、难定位某个任务标识的情况,idea中提供了任务标识的过滤器(filter)自定义功能。具体在Performance->Editor->Todo中,在Filters框中点击“+”添加,可以自定义过滤器名字、包含显示的标识。如下图,定义了“show my notes filter”过滤器,只包含显示 “my notes”任务标识:
通过上面的过滤器设置,我们可以在idea的todo窗口中点击过滤器选择我们的“show my notes filter”过滤器,只显示“my notes”任务标识。这样就可以从多个任务标识中筛选出来检索,一目了然: