IDEA注释模板设置【非常实用】

一、类模板设置

1、进入设置页面：File–>settings–>Editor–>File and Code Templates–>Files

2、设置类、接口、枚举模板信息

• 代码

  /**
  * @ClassName: ${NAME}
  * @Description: ${description}
  * @Author: liu-hao
  * @Date: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
  * @Version: 1.0
  **/
  

  /**
  * @InterfaceName: ${NAME}
  * @Description: ${description}
  * @Author: liu-hao
  * @Date: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
  * @Version: 1.0
  **/
  

  /**
  * @EnumName: ${NAME}
  * @Description: ${description}
  * @Author: liu-hao
  * @Date: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
  * @Version: 1.0
  **/
  

• 如图所示（类、接口、枚举）
  
  
  

3、点击Apply应用设置

• 效果展示

  package com.tygy.maven.test;
  
  /**
   * @ClassName: User
   * @Description: 用户类
   * @Author: liu-hao
   * @Date: 2019-10-10 21:39
   * @Version: 1.0
   **/
  public class User {
  	// TODO
  }
  

  package com.ychs.maven.test;
  
  /**
   * @InterfaceName: Persion
   * @Description: Persion接口
   * @Author: liu-hao
   * @Date: 2019-10-10 21:42
   * @Version: 1.0
   **/
  public interface Persion {
  	// TODO
  }
  

  package com.ychs.maven.test;
  
  /**
   * @EnumName: Persion
   * @Description: DateEnu枚举
   * @Author: liu-hao
   * @Date: 2019-10-10 21:45
   * @Version: 1.0
   **/
  public interface DateEnum {
  	// TODO
  }
  

二、方法模板设置

1、同样打开设置：File–>settings–>Editor–>Live Templates

2、新建模板组：命名为userDefine

3、选中新建的模板组，新建模板

• 新建模板
  
• 填写模板信息
  
  • 模板快捷键：IDEA生成注释的默认方式是：/* + 模板名 + 快捷键（比如若设置模板名为add快捷键用Tab，则生成方式为 /*add+Tab）
  • 快捷键设置（更新）：这里建议快捷键使用Tab，以区分系统自带的回车创建注释（下面快捷键还是以回车为例）
  • 方法注释模板

    * 
     * @Author: liu-hao 
     * @Description: $description$ 
     * @Date: $date$ $time$ 
     * @Param: $params$ 
     * @return: $return$ 
     **/
    

• 设置模板的应用场景
  • 设置前
    
  • 设置后
    
  • 设置应用场景（选择Java即可）
    
• 设置参数的获取方式
  • 点击Edit variables 打开设置
    
  • 在Expession列选择设置即可
    

4、点击Apply应用设置

• 效果展示

  /** 
   * @Author: liu-hao
   * @Description: 通过用户ID获取用户姓名 
   * @Date: 2019/10/10 21:45 
   * @Param: [userId] 
   * @return: java.lang.String 
   **/
  public String getName(String userId) {
      // TODO
      return null;
  }
  

5、注意：如果想参数分开展示，则需在参数Expession列添加脚本

• 参数添加脚本

  groovyScript("
  	if(\"${_1}\".length() == 2) {
  		return '';
  	} else {
  		def result=''; 
  		def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList();
  		for(i = 0; i < params.size(); i++) {
  			if(i==0){
  				result += params[i] + ' '
  			} else {
  				result += '\\n' + ' * @Param: ' + params[i]
  			}
  		};
  		return result;
  	}", methodParameters());
  

  
• 效果展示

  /**
   * @Author: liu-hao
   * @Description: 设置用户信息
   * @Date: 2019/10/10 21:45
   * @Param: userId 用户ID
   * @Param: userName 用户姓名
   * @return: java.lang.String
   **/
  public String setUserInfo(String userId, String userName) {
      // TODO
      return null;
  }
  

OK，你的好了吗，如果觉得不错，记得点个赞哦~~