IDEA 方法自动添加注释

想给方法自动添加注释，在网上找的各种脚本都有各种问题，于是自己修改调整了一下，能正常使用了，特此记录一下。

过程如下：

File --> Settings --> Editor --> Live Templates

--> 右侧点 " + " 选 "Templates Groups" 起名（MyGroup）

--> 选中 MyGroup --> 右侧点 " + " 选 "Live Templates"

--> 填写快捷键 Abbreviation ，这里我填的是 ' * '，所填的快捷键+Tab 会将快捷键（如 ' * '）替换成模板，使用方法是在方法的上一行输出 /** + tab ；右侧 description 是快捷键的提示，会在程序里出现

--> 填写模板 Template text

** @decription TODO
$param$* @return $return$        * @author $user$* @createDate $date$ */

--> 编辑变量，点击 "Editor variables"，return、user、date 变量在 Expression框下拉选择相应的即可

重点是 param，这个需要输入groove 脚本，如下，处理了有参，无参的情况

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

最后选择适合自己的作用域，这里选的是 java

有参、无参、有返回值、无返回值等的使用效果如下

IDEA 方法自动添加注释相关推荐

IDEA类和方法自动添加注释
给类自动添加注释信息给方法自动添加注释信息给类自动加上注释第一步点击File里的Settings先到设置里面去第二步,在Settings里面按照下图顺序找到设置界面,右边即为设置界面第三步, ...
java 类和方法自动添加注释
设置文件头File Header 路径为 setting-->editor-->File and Code Templates-->Includes-->File Header ...
eclipse java 注释_Eclipse中自动添加注释（两种）
方法一:Eclipse中设置在创建新类时自动生成注释 windows-->preference Java-->Code Style-->Code Templates code--&g ...
Eclipse中自动添加注释
方法一:Eclipse中设置在创建新类时自动生成注释 windows-->preference Java-->Code Style-->Code Templates code- ...
如何在Eclipse中如何自动添加注释和自定义注释风格
背景简介丰富的注释和良好的代码规范,对于代码的阅读性和可维护性起着至关重要的作用.几乎每个公司对这的要求还是比较严格的,往往会形成自己的一套编码规范.但是再实施过程中,如果全靠手动完成,不仅效率低下 ...
Pycharm工具Python开发自动添加注释（详细）
方法自动添加注释定义了一个函数,在函数下面敲入了三个双引号后,enter回车并没有自动出现注释,如图: 解决办法 Pycharm中依次打开File -> Settings -> Tool ...
python 为html页面增加背景_Python 给html css自动添加注释
Python 给html css自动添加注释(2020年11月8日) 背景大二上学期专业开设了网页设计课程,专门学习html和css,有时候也经常有同学找我来帮忙看看他们写的代码,并且改改,我就忽然 ...
Eclipse中代码自动添加注释及代码注释模板
介绍为了提高代码的可读性以及为了有些代码有洁癖的人的需求,我们要从学生到职业进行迈进的过程中,必须把以前的那种代码可读性不高的习惯改掉,因为我们必须要与企业接轨.. 好了,废话不多说,反正就是提升自 ...
linux vim配置注释,vim自动添加注释
linux版本:CentOS Linux release 7.3.1611 普通用户或超级用户,查看有无 .vimrc文件,如果没有就使用命令: touch .vimrc 创建一个文件 # vi ~/ ...
VSCode一键生成、自动添加注释
VSCode自动添加注释首先在商店搜索插件:koroFileHeader,安装后重启客户端以生效在设置中搜索fileheader,找到如下setting.json的配置文件,随便点开一个即可以下 ...

IDEA 方法自动添加注释

IDEA 方法自动添加注释相关推荐

最新文章

热门文章