IDEA 类和方法注释签名设置

类的注释

进入idea Settings-Editor-File and Code Templates选择Class，可以看到有 #parse("File Header.java")，即为 Includes标签下的File Header，这里添加上类的注释说明，如下：

/**
 * @description: some desc
 * @author: ${USER}
 * @email: xxx@xx.com
 * @date: ${DATE} ${TIME}
 */

设置完成后效果如下：

问题1：如果出现author显示的是windows系统的用户名的话，但是想修改为自己的用户名，可以在idea Help下找到Edit Custom VM Options...,并在最后添加上：-Duser.name=xxx

另外，如果直接修改idea安装目录下的vmoptions不起作用的话，可以去用户目录下找到此文件并修改。参考http://www.jetbrains.com/help/idea/2016.2/increasing-memory-heap.html

 

方法注释

1.找到 Live Templates,点击右上角+号，选择template group，并输入你自定义的分组名称，例如MyTemplate

2.选中MyTemplate，再点击+号，添加Live Template。

Abbreviation 写 * ,Description随意，template text 写你需要的注释内容，例如：

*
* $END$
* </br>
$param$
$return$
* @author $user$
* @date $date$
*/

3.修改 注释的值，点击Edit variables。

勾选 Reformat according to style 为了解决添加完注释后缩进的问题

params:脚本如下，用于处理方法参数为多个时，分行显示

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

 return：脚本如下，用于处理当返回值为 void时，注释报错的问题

groovyScript("def result=''; def data=\"${_1}\"; def stop=false; if(data==null || data=='null' || data=='' || data=='void' ) { stop=true; }; if(!stop) { result += ' * @return {@link ' + data+'}'; }; return result;", methodReturnType())

最总效果如下：