IDEA 笔记 -- 注释模板整理合集

1、类注释

设置路径：打开File->Setting->Editor->Filr and Code Templates->Files->Class，如下图所示：

分别在文件最上方添加文件注释，在类名上方添加类注释

文件注释格式如下：

类注释格式如下：

/**
* 功能描述:<br>
*
* @author ${USER}
* @see [相关类/方法]（可选）
* @since [产品/模块版本] （可选）
*/
 

完整格式内容如下：

/*
 * Copyright (C), 2002-${YEAR}, 苏宁易购电子商务有限公司
 * FileName: ${NAME}.java
 * Author:   ${USER}
 * Date:     ${DATE} ${TIME}
 * Description: //模块目的、功能描述      
 * History: //修改记录
 * <author>      <time>      <version>    <desc>
 * 修改人姓名    修改时间    版本号       描述
 */

/**
* 功能描述:<br>
*
* @author ${USER}
* @see [相关类/方法]（可选）
* @since [产品/模块版本] （可选）
*/
public class ${NAME} {
}

2、方法注释

这里主要是为IDEA中自动生成的Getter、Setter方法添加注释

使用快捷键（ALt + Insert）打开Getter、Setter设置，选择Getter and Setter -> Getter template 和 Setter template -> 新建template模板 -> 保存模板 -> 返回模板页面选择自定义模板

Getter 注释模板：

/**
* Gets the value of $field.name
* @return the value of $field.name
*/
public ##
#if($field.modifierStatic)
static ##
#end
$field.type ##
#set($name = $StringUtil.capitalizeWithJavaBeanConvention($StringUtil.sanitizeJavaIdentifier($helper.getPropertyName($field, $project))))
#if ($field.boolean && $field.primitive)
#if ($StringUtil.startsWithIgnoreCase($name, 'is'))
#set($name = $StringUtil.decapitalize($name))
#else
is##
#end
#else
get##
#end
${name}() {
return $field.name;
}

 

Setter 注释模板

/**
* Sets the $field.name
* @param $field.name $field.name
*/
#set($paramName = $helper.getParamName($field, $project))
public ##
#if($field.modifierStatic)
static ##
#end
void set$StringUtil.capitalizeWithJavaBeanConvention($StringUtil.sanitizeJavaIdentifier($helper.getPropertyName($field, $project)))($field.type $paramName) {
#if ($field.name == $paramName)
#if (!$field.modifierStatic)
this.##
#else
$classname.##
#end
#end
$field.name = $paramName;
}

3、自定义注释模板

方案一：使用javaDoc2插件（推荐）
1）在IDEA插件(File -> Settings -> plugins -> browse Repositories)中搜索 javaDoc2，如下图所示，下载安装后重启

2）打开File -> Settings -> Other Settings -> JavaDoc (如果没有找到该选项，检查下是否重启了IDEA)

先配置General:在默认的基础上，将Visibility下面的Private勾选上，Other选项下，Comment overridden methods勾选上

然后在配置Templates

这里可以分别配置类注释、构造方法注释、方法注释、属性注释如下图所示

这里左边Regular expression 为匹配名称的正则表达式，右边Preview为注释模板， 这里会优先匹配最上面的表达式、未匹配到则依次往下， ".+"可以匹配所有。

这里可以设置类注释模板“.+”，内容如下：

/**\n
* 功能描述:<br>\n
* 详细功能描述\n
* @author 18047066（替换成自己的用户名）\n
* @see [相关类/方法]（可选）\n
* @since [产品/模块版本] （可选）\n
*/

方法注释模板也可以配置“.+”，内容如下：

/**\n
* 功能描述: <br> \n
* 〈功能详细描述〉\n
*\n
<#list element.parameterList.parameters as parameter>
* @param ${parameter.name} ${parameter.name}\n
</#list>
<#if isNotVoid>
*\n
* @return ${return}\n
</#if>
<#if element.throwsList.referenceElements?has_content>
*\n
</#if>
<#list element.throwsList.referenceElements as exception>
* @throws ${exception.referenceName} ${exception.referenceName}\n
</#list>
*@author  （替换成自己的用户名） \n
*/

配置完成后进入代码编码页面，将光标放置在类名或者方法名上，同时按下 ALT + INSERT 调出使用面板，点击创建注释。

也可以选择类或者方法名后直接使用快捷键ALT + SHIFT + G（如果不起效，检查下快捷键是否被占用了），直接就可以生成注释。

方案二：自定义

1. 打开File -> Settings -> Editor -> Live Templates 点击右侧加号，选择新建template group
   

2. 选择自定义的group，点击右侧加号，新建Live Template

3. 编辑自定义模板： Abbreviation 填写*(这里必须为*) -> description可以定义 -> 选择生效范围（选择java下所有选项即可） -> 设置触发按键（ENTER、TABAL、SPACE） -> 配置Template text

Template text 内容如下

*
 * 功能描述: <br>
 * 〈功能详细描述〉
 *
 * $VAR1$ 
 * @return $returns$
 * @author $user$
 */

4. 定义变量： 点击 Edit variables，配置如下图

其中： groovyScript脚本内容为：

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

备注：Abbreaviation + Expand With 为注释触发操作，即本配置中 * + enter 就可以带出注释。正常情况下，输入/** + ENTER后即可带出方法注释。