1. 程式人生 > 其它 >Idea 設定自動註釋,並解決自動註釋的@param和@return為null的問題

Idea 設定自動註釋,並解決自動註釋的@param和@return為null的問題

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

在public class ${NAME} 上邊輸入你想要設定的註釋, 這裡是我的設定

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

注意:當你設定 @description:${description} 和 @version: v e r s i o n versionversion 時每次新建類都會 出現
不想每次都輸入的話,可以不設定 ${description} 和 $version
設定完成點選apply.
現在每次新建類都會自動生成註釋

/**
 * @author HuangHaiyang
 * @date 2020-05-07 22:45
 * @description:這是一個測試類
 * @version: 1.0.0
 */
public class Test {

}

設定自動生成方法的註釋
live Templates--------->點選+ --------------->選擇 Template Group 這時會彈出一個框,輸入一個名字,我的叫MyGroup

Abbreviation 快捷生成註釋 隨便寫 最好設定為* 比較簡單
Description 描述,隨便寫
Template text 就是你要生成的模板
這是我的配置

注意
第一個/不是我漏掉了,只要寫上第一個/,你的@param和@return都會為null
千萬不要寫上第一個/
千萬不要寫上第一個/
千萬不要寫上第一個/

**
 * 
 * @Author  zhangliang
 * @Date   $date$ $time$
 $params$
 * @Return $return$
 * @Exception   $exception$
 * @Description 
 */

下邊有一行勾選,可以選everyone 也可以只選java

點選 Edit variables

我的配置
date
date(“yyyy-MM-dd”)
time
time(“HH:mm”)
params
groovyScript(“def result=’’; def params=”${_1}".replaceAll(’[\\[|\\]|\\s]’, ‘’).split(’,’).toList(); for(i = 0; i < params.size(); i++) {if(params[i] == ‘’) return result;if(i==0) result += ‘\n’; result+=’ * @param ’ + params[i] + ((i < params.size() - 1) ? ‘\n’ : ‘’)}; return result", methodParameters())
(注意 這個寫在default value)
return
methodReturnType()

點選ok apply ok

最重要的一步
在你要生成註釋的地方輸入 / 再加上tab*
如果你之前設的Abbreviation不是 ,你要輸入 / 你的Abbreviation的值 再加上tab*

/**
 * @author HuangHaiyang
 * @date 2020-05-07 22:45
 * @description:這是一個測試類
 * @version: 1.0.0
 */
public class Test {
    /**
     * create time: 2020-05-07 23:05
     * @param null
     * @return 
     */
    private int age;
    private String name;
    /**
     * create time: 2020-05-07 23:05
     * @param age
     * @param name
     * @return 
     */
    public Test(int age, String name) {
        this.age = age;
        this.name = name;
    }

    public int getAge() {
        return age;
    }
    /**
     * create time: 2020-05-07 23:05
     * @param age
     * @return void
     */
    public void setAge(int age) {
        this.age = age;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}

完成


原文章地址:https://blog.csdn.net/weixin_45007916/article/details/105983598