IDEA的TODO的使用方式
目录
在日常开发中,使用todo标记能够让我们快速定位到未完成开发内容代码上,提高开发效率,以下就是如何使用idea的TODO标记。
1. 在代码中编写一个TODO标记
// TODO 标记内容,这里只要是有TODO这个关键词,idea的TODO菜单就能查找到该标记。
2. 自定义一个TODO标签,并设置TODO过滤器
在多人开发时,大家都可能编写TODO标签,为了在TODO中快速查找自己的标签,那么你就要自定义一个TODO标签,使用过滤器来筛选。
以下设置,在idea的seting->TODO中,或者自己在TODO菜单窗口的filter中选择edit filters进行设置
自定义TODO标签
在这里,你可以设置是否忽略大小写,字体、颜色等等。
添加过滤器
然后你就可以在TODO的filter中选择自己的标签,就可以筛选了
3. 为了方便打出TODO
可以编写一个live Templater,快速打出TODO-wn类似的标签
这是如何添加代码模板的文章
这是阿里巴巴手册中关于TODO 标记的编写指南
【参考】特殊注释标记,请注明标记人与标记时间。注意及时处理这些标记,通过标记扫描, 经常清理此类标记。线上故障有时候就是来源于这些标记处的代码。
1) 待办事宜(TODO):( 标记人,标记时间,[预计处理时间]) 表示需要实现,但目前还未实现的功能。 这实际上是一个 Javadoc 的标签,目前的 Javadoc 还没有实现,但已经被广泛使用。只能应用于类,接口和方法(因为它是一个 Javadoc 标签)。
2) 错误,不能工作(FIXME):(标记人,标记时间,[预计处理时间]) 在注释中用 FIXME 标记某代码是错误的,而且不能工作,需要及时纠正的情况
总结
以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。
您可能感兴趣的文章: