代码注释规范-IDEA 配置 Java 类 方法注释模板

三种常用的 Java 注释方式

  // 声明常量
  int number;

    /*
     * 类主函数
     */
    public static void main(String[] args) {
    }

    /**
     * @param masterId    品牌商Id
     * @param shopId    店铺Id
     * @param skuId        商品skuId
     * @description: 校验商品标识码与店铺的所属关系
     * @return: net.jdcloud.APIECRM.model.ValidateSkuUsingGETResponse
     * @author: niaonao
     * @date: 2020/01/13
     */
    public static ValidateSkuUsingGETResponse validateSkuUsing(String masterId, String shopId, String skuId){
        return null;
    }

自定义注释模板

类注释模板

配置模板
菜单路径 File-Settings-Editor-File and Code Templates-Incudes-File Header 下添加注释模板，配置模板后点击 Apply OK 应用。
自定义注释模板:

/**
* @className: ${NAME}
* @description: TODO 类描述 
* @author: niaonao
* @date:  ${DATE}
**/

自定义注释模板不完全变量参考表

方法注释模板

配置模板
菜单路径 File-Settings-Editor-Live Templates 下添加一个新模板组，名字自定义 JavaTemplateGroup。选中模板组，右侧点击新增按钮，创建新模板。

•Abbreviation 配置为* 。
•Description 自定义描述信息。
•Template Text 自定义模板

/**
 $param$
 * @description: TODO
 * @return: $return$
 * @author: niaonao
 * @date: $date$
 */

Edit variables 编辑变量
•变量 return 表达式为 methodReturnType()
•变量 date 表达式为 date()
•变量 param 表达式为

若有警告信息 No Applicable contexts，点击 Define 选中 Java 即可

此处 Expend With 配置为 Enter 回车键，注释生成快捷方式，看个人习惯，也可以时 Tab 键。

点击 Apply OK 应用配置即可

补充说明

方法注释模板不可用在，方法外，若用在方法外 @param 获取不到，注释为 @param null;
类注释模板在文件创建时生成，已创建文件不会触发该模板，会触发方法注释模板。