栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

idea 设置自动生成类和方法注释,TODO标记作者日期信息以及过滤自己所写标记

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

idea 设置自动生成类和方法注释,TODO标记作者日期信息以及过滤自己所写标记

HAI,这是我的第一篇博客; 一直都是在csdn上学习,有所收获也应该写博客回报猿友们; 今天写一篇分享如何配置idea的类注释和方法注释(遵循阿里开发规范),还有todo注释(这个也很重要,谁的问题谁解决,而不是在项目中让todo标记越堆越多);

一.文件头注释(不限于类,包括接口等) 1.配置图

 2.代码块

3.效果图

 

 2.代码块
 

3.效果图

配置好后,创建类时就自带作者,日期信息了(当然也可以加一些其他字段信息,如版本version等,作者没有用到,个人觉得不够清爽美观)。遵循了阿里规范就行。

二.方法注释

先创建一个模板组,名字自定义,我这里名字是myGroup。

接下来创建模板m,第4步的缩写m就是配置完成后的快捷键,这样配置快捷键即为:/+m+Enter

1.配置图

 

 2.代码块
**
 * @Author $USER$
 * @Date $date$ $time$ 
 * @Param $param$
 * @return $return$
 * @Description $description$       
 */
3.效果图

 

三.todo标记注释 (1).todo标记快捷键设置

todo注释和上面的方法注释是类似的,

虽然todo快捷键已经可以快速创建标记,但是不携带作者信息,而且不支持创建人过滤,所以配置一下非常有必要

还是在自己创建的mygroup组下(一些其他的快捷键设置都是类似套路),创建模板todo,快捷键即为:/+todo+Enter (直接todo也可以,需要手动选择一下)

1.配置图

 2.代码块

这里的后缀-wcm也是自定义(这里为作者名字缩写),需要注意和筛选器名称保持一致

//todo-wcm $USER$ $date$ $time$ 
3.效果图

 

(2).TODO筛选器配置 1.配置图

先点击上方加号,参照已有创建一个编辑模式:btodo-wcmb.* 

 

再点击下方加号创建一个编辑器,模式选为上面创建的编辑模式:todo-wcm

 

2.效果图

这样,在控制台TODO窗口中就可以筛选所有是你做的todo标记了

3.注:我们的项目目前有44个todo标记,很多都是前辈留下的,不敢擅自动 

 

参考链接(作者:小虚竹):https://blog.csdn.net/shi_hong_fei_hei/article/details/86606414?ops_request_misc=&request_id=&biz_id=102&utm_term=idea%20%E6%80%8E%E4%B9%88%E8%AE%BE%E7%BD%AEtodo%E5%B8%A6%E4%BD%9C%E8%80%85&utm_medium=distribute.pc_search_result.none-task-blog-2~all~sobaiduweb~default-1-86606414.142^v35^new_blog_fixed_pos,185^v2^control&spm=1018.2226.3001.4187

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/1031215.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号