Menu Close

IDEA代码注释配置

lcc0556

1. 配置全局中USER

在此配置全局USER，用于填充自动生成的注释中的作者@author属性。

Help->Edit Custom VM Options...

增加如下配置：-Duser.name=xxx
示例：

2. 配置类注释模板

settings->Editor->File and Code Templates->files->class

file

2.1. 增加注释模板

/**
 * ${description}
 *
 * @author ${USER}
 * @date ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
 **/

模板增加后，如下（注释上方的换行符必须有）：

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")

/**
 * ${description}
 *
 * @author ${USER}
 * @date ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
 **/
public class ${NAME} {
}

2.2. 使用方法

新创建java文件时，会提示输入类描述description，生成的文件格式如下：

/**
 * 我的测试类
 *
 * @author LiuChangchun
 * @date 2022-04-23 14:36
 **/

3. 配置方法注释

3.1. 配置流程

从菜单中依次选择File -> Settings -> Editor -> Live Templates

第一步：首先点击Editor下的Live Templates,再点击右上角的加号，然后选取Template Group

第二步：点击右侧加号，选择Template Group，并新创建一个模板组，命名为：MyGroup(名称根据自己喜好填写)

file

第三步：创建完成后，自动定位到刚创建的组，点击右上角，选择Live Template

file

第四步：模板配置
file

①、缩写：即需要生成注释时所有的名称，这里定义为 notes,当我们需要对某个方法书写注释时，只要在方法上填写 /notes 即自动生成注释。

②、描述：仅针对该模板的描述，不是针对代码中方法的描述。

③、模板内容：如下（注意第一行的两个 ** 必须顶格写，否则生成的注释会出错）

**
 * $description$
 *
$params$
$return$
 */

④、解发条件：配置如图如示。

⑤、适用场景：勾选Java即可。

file

⑥、变量模板配置：

file

Expression是表达式，可以使用一些默认函数，如日期、时间等。

DefaultValue是默认值，如图params从网上搜索然后加以修改的自动生成方法参数的脚本。

最后一项如果取消勾选生成后就不会自动选中让你编辑内容，如图我的description就是没有勾选，注释生成后就会光标就回到description后面让我输入内容。

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

3.2. 使用方法

在java方法上输入 /notes 后，按下tab键或者回车键，即可在方法上方生成方法注释，如下：

 /**
  * （①方法描述）
  *
  * @param value  （②参数描述）
  * @param offset （②参数描述）
  * @param count  （②参数描述）
  * @return java.lang.String （③返回值描述）
  */

3.3. 注意事项

（1）为避免对变量注释时的影响，变量的注释仍然采用默认的注释方式：/** + 回车，生成的注释仍然是默认注释。

（2）无参方法，将不生成@param参数。

附录

参考：idea配置阿里格式化模板+注释模板：https://www.cnblogs.com/ios9/p/14583338.html

Post Views: 775
Tagged ,