idear注解配置

以你之姓@ 2023-10-06 20:34 5阅读 0赞

##### idear注解配置 #####

###### 1.生成的自动注释 ######

1.File------>settings----------->Editor---------------->File and Code Templates--------->（file）class

2.在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 时每次新建类都会 出现![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTAwNzkxNg_size_16_color_FFFFFF_t_70_pic_right]  
不想每次都输入的话，可以不设置 $\{description\} 和 $version 设置完成点击apply

现在每次新建类都会自动生成注释

/**
     * @author HuangHaiyang
     * @date 2020-05-07 22:45
     * @description:这是一个测试类
     * @version: 1.0.0
     */
    public class Test {
        
    
    }

###### 2.代码的自动注释 ######

live Templates--------->点击+ --------------->选择 Template Group 这时会弹出一个框，输入一个名字，我的叫MyGroup

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTAwNzkxNg_size_16_color_FFFFFF_t_70_pic_center]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTAwNzkxNg_size_16_color_FFFFFF_t_70_pic_center 1]

Abbreviation 快捷生成注释 随便写 最好设置为\* 比较简单  
Description 描述，随便写  
Template text 就是你要生成的模板  
这是我的配置

**
     * create time: $date$ $time$
     $params$
     * @return $return$
     */

点击 Edit variables

![img][]

我的配置  
date：date(“yyyy-MM-dd”)  
time：time(“HH:mm”)params  
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

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

**最重要的一步**  
**在你要生成注释的地方输入 /\* 再加上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;
        }
    }

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTAwNzkxNg_size_16_color_FFFFFF_t_70_pic_right]: https://img-blog.csdnimg.cn/20200507224314389.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTAwNzkxNg==,size_16,color_FFFFFF,t_70#pic_right
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTAwNzkxNg_size_16_color_FFFFFF_t_70_pic_center]: https://img-blog.csdnimg.cn/20200507224940435.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTAwNzkxNg==,size_16,color_FFFFFF,t_70#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTAwNzkxNg_size_16_color_FFFFFF_t_70_pic_center 1]: https://img-blog.csdnimg.cn/20200507225239638.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTAwNzkxNg==,size_16,color_FFFFFF,t_70#pic_center
[img]: https://img-blog.csdnimg.cn/20200507230127589.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTAwNzkxNg==,size_16,color_FFFFFF,t_70#pic_center