创建文件自动注释

打开设置
选择需要添加模版的文件类型
填写需要的模版内容，变量需要用两个美元符号修饰具体变量值名称对应见附
点击保存,创建文件后会自动添加文件注释

实例：

模版内容：

 /**
  * Project Name: ${PROJECT_NAME}
  * File Name: ${NAME} 
  * Package Name: ${PACKAGE_NAME}
  * Date: ${DATE} ${TIME}
  * Copyright (c) ${YEAR},All Rights Reserved.
  */

实际效果：

/**
 * Project Name: demot
 * File Name: test
 * Package Name: com.chuangxiang.ex1.ex2.ex3.ex4.ex5.demot
 * Date: 2019-03-26 上午 11:03
 * Copyright (c) 2019,All Rights Reserved.
 */
package com.chuangxiang.ex1.ex2.ex3.ex4.ex5.demot;

public class test {
}

SETTER 和 GETTER 方法自动注释

打开设置
打开插件搜索
搜索 generateGSDoc 插件并安装，安装完成后需要重新启动 IntelliJ IDEA
设置 setter 和 getter 方法的注释内容

5.点击保存生效，在编辑区域 Alt + Ins 呼出菜单，选择 generateGSDoc，会在自动生成的方法上添加定义好的注释。注意：#{bare_field_comment} 只有在属性有注释的时候才会有效。
IntelliJ IDEA 模版配置（自动生成注释内容）

实例：

SET 模版内容：

/**
 * 设置 #{bare_field_comment}
 * 
 * @param ${field.name} the #{bare_field_comment} to set 
 * @since   JDK 1.8
 */

GET 模版内容：

/**
 * 获取 #{bare_field_comment}
 * 
 * @return the ${field.name} #{bare_field_comment}  
 * @since   JDK 1.8
 */

实际效果：

public class test {
    /**
     *姓名
     */
    private String name;


    /**
     * 获取 姓名
     *
     * @return the name 姓名  
     * @since jdk 1.8
     */
    public String getName() {
        return this.name;
    }

    /**
     * 设置 姓名
     *
     * @param name the 姓名 to set 
     * @since jdk 1.8
     */
    public void setName(String name) {
        this.name = name;
    }
}

方法注释

打开设置
新建一个自己的模版分组（便于以后管理）
在创建的模版组下创建一个新的模版
模版中变量与表达式对应

5.应用保存，在编辑区域输入 *method + 回车，自动添加注释
IntelliJ IDEA 模版配置（自动生成注释内容）

实例：

模版内容：

/**
 * @author: $author$  
 * date: $date$ $time$
 * @since: JDK 1.8
 * 
 * @description: 这里用一句话描述这个方法的作用 
 * @param: $param$
 * @return: $return$
 */

实际效果：

    /**
     * @author:
     * date: 2019-03-26 下午 2:44
     * @since: JDK 1.8
     *
     * @description: 这里用一句话描述这个方法的作用
     * @param: [name]
     * @return: void
     */
    public void test(String name){

    }

附：模版变量名称对应

${PACKAGE_NAME} - 创建新类或接口的目标包的名称。

${PROJECT_NAME} - 当前项目的名称。

${FILE_NAME} - 将要创建的文件的名称。

${NAME} - 您在创建文件的过程中，在 “新建文件” 对话框中指定的新文件的名称。

${USER} - 当前用户的登录名。

${DATE} - 当前系统日期。

${TIME} - 当前系统时间。

${YEAR} - 本年。

${MONTH} - 本月。

${DAY} - 当月的当前日期。

${HOUR} - 当前时间

${MINUTE} - 当前分钟。

${PRODUCT_NAME} - 将在其中创建文件的 IDE 的名称。

${MONTH_NAME_SHORT} - 月份名称的前3个字母。示例：1月，2月等。

${MONTH_NAME_FULL} - 一个月的全名

${NAME} - 将为其生成 PHPDoc 注释的类，字段或函数（方法）的名称。

${NAMESPACE} - 类或字段命名空间的完全限定名（无斜杠）。

${CLASS_NAME} - 定义了生成 PHPDoc 注释的字段的类的名称。

${STATIC} - 如果要为其生成注释的函数 (方法) 或字段为静态（static），则获取静态值。否则计算结果为空字符串。

${TYPE_HINT} - 提示函数 (方法) 的返回值以生成注释。如果无法通过函数 (方法) 的静态分析检测到返回类型，则计算结果为 void。

${PARAM_DOC} - 参数的文档注释。计算为一组@param类型名称的行。如果要为其生成注释的函数不包含任何参数，则该变量将计算为空内容。

${THROWS_DOC} - 异常的文档注释。计算结果为一组@throws类型的行。如果要为其生成注释的函数不抛出任何异常，则该变量将计算为空内容。

${DS}- 一个美元字符（$ ）。该变量计算为一个简单的美元字符（ $），该变量的计算结果为纯美元字符($ )，当您需要转义此符号时使用它，使其不被视为变量的前缀。

IntelliJ IDEA 模版配置（自动生成注释内容）

文章目录

创建文件自动注释

SETTER 和 GETTER 方法自动注释

方法注释

附：模版变量名称对应

相关推荐