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



