美文网首页
idea添加注释

idea添加注释

作者: ankicoo | 来源:发表于2020-05-27 16:32 被阅读0次

类注释

 /**
 * description: ${DESCRIPTION}
 * author: FUHA
 * created_time: ${DATE} ${TIME}
 */

方法注释

/**
 * description: 
 * author: FUHA
 * create_time: $DATE$ $TIME$
 */
1.添加自定义注释分组
打开设置找到对应操作界面
自定义分组
2.添加自定义注释
添加动态模板
基本内容配置
选定对应内容 如DATE 可直接选中date()
选定该注释适用的范围,一般选全部
选定适用范围

使用效果

输入出现注释提示
回车确认输入出现配置的自定义注释

附加

添加自动获取参数注释

$param$
groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\n' : '')}; return result", methodParameters())

快捷注释(推荐使用)

    输入`/**`+`Enter` 可以自动获取方法上的参数并自动添加@param @return的内容
    常用于自己编写的service类的方法上,方法多的时候 简介的注释会更加好看。 
快捷注释.png
注意: 快捷注释添加完之后千万记得添加对应的字段描述,否则注释毫无意义可言 而且会出现如图的警告(来源于idea插件 Alibaba Java Coding Guidelines)

相关文章

网友评论

      本文标题:idea添加注释

      本文链接:https://www.haomeiwen.com/subject/fjgwahtx.html