idea设置方法注释

1、给创建的文件自动添加注释信息

/**
 * @ClassName: ${NAME}
 * @Description:
 * @Author: ${USER}
 * @Date: ${DATE} ${TIME}
 */

 

因为IDEA生成注释的默认方式是：/* +模板名+快捷键（比如若设置模板名为add快捷键用Tab，则生成方式为/*add+Tab），如果不采用这样的生成方式IDEA中没有内容的方法将不可用，例如获取方法参数的methodParameters(）、获取方法返回值的methodReturnType(）

 

1.3 设置方法注释的快捷键

*
 * Description: 
$param$
 * @Return: $return$
 * @Author: $user$
 * @Date: $DATE$ $TIME$
 */

 

 

注意 点击模板页面最下方的警告，来设置将模板应用于那些场景，一般选择Java即可（如果曾经修改过，则显示为Change而不是Define）

再次选择右侧的Edit variables按钮，下拉框就有选项了；如下图，选中对应的Expression，点击OK

 然后点击Edit variables，会读取刚刚在注释模板中的配置的参数${参数名}$。在Expression的下拉框中选择方法为其赋值。

 

5、参数赋值优化

（1）如果param参数使用默认的methodParameters()来获取方法参数值，其注释参数是在一行展示的，如下图。这里我们希望像MyEclipse中一样，一行一个参数的样式，可以通过脚本来实现。将以下脚本复制进Expression，可以得到文章开头效果图的样式：

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) ? '\\r\\n' : '')}; return result", methodParameters())

 

（2）如果return参数使用默认的methodReturnType()来获取参数值，模板里使用了@link来跳转结果类型，那么当方法返回值为void时，注释会报错，如下图。可以通过脚本来避免，将上面模板中的@link参数去掉，将以下脚本复制进Expression：

groovyScript("def result=\"${_1}\"; if(result == \"void\"){return \"\";}else{return \"{@link \"+result+\"}\";}", methodReturnType())

 

6、注释模板的调用。通过输入 / + * + Tab键，即先输 /* 再按Tab键，就可以调用模板。因为刚刚我们把*被设置为模板的代号，Tab键设置为模板的扩展快捷键，也可以把Tab改为Enter键，更加还原MyEclipse。

 

PS:（1）注意，注释模板开头不要使用/，因为设置后虽然可以更便捷的使用 * + Tab键，调用模板。但是会存在param为null的情况（原因暂时未知），如下图，需要在方法内调用才能获取参数，但这样还需要将注释复制到方法外反而使用不便。

 

（2）注释模板中的user参数是获取系统的用户（当然注释作者也可以直接写固定值，但是配置更有意思，哈哈），经常不是自己需要的作者名，可以在IDEA中进行配置。打开→IDEA的安装目录\bin\idea64.exe.vmoptions。在最下面增加一行-Duser.name=username。

其中username就是你希望为user参数的赋值。

 

（3）注释模板中的date参数是获取系统的时间及格式（即桌面右下角的时间及格式），而WIN10下系统时间格式是可以调整的。右键桌面右下角的系统时间→调整日期/时间→日期、时间和区域格式设置→更改数据格式→调整“短日期格式”。