IntelliJ IDEA 自动生成方法注释

97 阅读1分钟

IDEA版本:2025.1.3 Ultimate Edition

  1. 打开“设置”(Ctrl + Alt + S)
  2. 打开“编辑器”->“实时模板”
  3. 点击“+”,添加模板组、实时模板
  4. 实时模板“缩写”设为:mm
  5. 模板文本设为以下内容:
*
 * $desc$
 *
$params$
$returns$
 * @author 草木
 * @version 1.0
 * @date $date$ $time$
 */
  1. 点击“编辑变量”,并设置变量表达式如下:
变量表达式
desc
params详见下方
returns详见下方
datedate()
timetime()
groovyScript("
  def result = '';
  def params = \"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList();
  for (i = 0; i < params.size(); i++) {
    if (params[i] != '') {
      result += ' * @param ' + params[i] + ((i < params.size() - 1) ? '\\r\\n' : '');
    }
  };
  return result == '' ? null : result;
", methodParameters())
groovyScript("
  return \"${_1}\" == 'void' ? null : ' * @return ' + \"${_1}\"
", methodReturnType())
  1. 保存以上变量设置,返回实时模板页面,将“展开方式”设为“空格”,设置“适用上下文”为Java。
  2. 点击“确定”,保存实时模板配置。
  3. 在方法声明上一行,输入“/*mm”,点击空格
/*mm
public Integer mtd(String s1, String s2) {
  return null;
}
  1. 自动生成注释如下:
/**
 * 
 *
 * @param s1
 * @param s2
 * @return java.lang.Integer
 * @author 草木
 * @version 1.0
 * @date 2025/9/3 12:00:00
 */
public Integer mtd(String s1, String s2) {
  return null;
}