IDEA注释设置类、方法注释模板(params和return显示)

阳光穿透心脏的1/2处 2023-09-23 21:13 135阅读 0赞

# 1.生成类注释 #

打开Setting  
Editor -> File and Code Templates -> Files -> Class  
![在这里插入图片描述][e3ada10859374277bb201cd035287d6b.png]

# 1.1模板： #

/**
    * @program: ${PROJECT_NAME}
    *
    * @description: ${description}
    *
    * @author: Amy
    *
    * @create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
    **/

## 1.2效果图： ##

![在这里插入图片描述][6d20b6ca435248fca5873184216a2a09.png]

# 2.生成方法注释 #

打开Setting  
Editor -> Live Templates -> 点击右边加号为自己添加一个Templates Group -> 然后选中自己的Group再次点击加号添加Live Templates  
![在这里插入图片描述][073a65a70196471a8cb356aba59f150e.png]

## 2.1 添加Templates Group和Live Templates ##

![在这里插入图片描述][ecc018aaa5e5468aaf0e851e6e29b1b4.png]

## 2.2 生成方法注解模板 ##

/**
    * @Description: $description$
    * @Param: $params$
    * @return: $returns$
    * @Author: Amy
    * @Date: $date$
    */

**注意事项：**  
![在这里插入图片描述][269b0cecb919464f806a9596893c991d.png]

![在这里插入图片描述][90bad0cea84e40628338547f9bbc4647.png]

## 2.3 Edit variables里面添加参数和返回值的自动取值 ##

![在这里插入图片描述][8f000b8b11404a498613d6cc4b1f71d3.png]

## 2.4 效果图 ##

![在这里插入图片描述][6d81e891c9df404fa559e389775dd733.png]  
**补充：**  
其中params和return都是设置 Default value groovyScript脚本

params groovyScript脚本

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+='* @Param ' + params[i] + ': '}else{result+='\\n' + ' * @Param ' + params[i] + ': '}}; return result;}", methodParameters());

return groovyScript脚本

groovyScript("def returnType = \"${_1}\"; def result = '* @return: ' + returnType; return result;", methodReturnType());

设置 点击 应用，确定

![在这里插入图片描述][40d38b3c43e64581bd6eeebaadec4960.png]

[e3ada10859374277bb201cd035287d6b.png]: https://img-blog.csdnimg.cn/e3ada10859374277bb201cd035287d6b.png
[6d20b6ca435248fca5873184216a2a09.png]: https://img-blog.csdnimg.cn/6d20b6ca435248fca5873184216a2a09.png
[073a65a70196471a8cb356aba59f150e.png]: https://img-blog.csdnimg.cn/073a65a70196471a8cb356aba59f150e.png
[ecc018aaa5e5468aaf0e851e6e29b1b4.png]: https://img-blog.csdnimg.cn/ecc018aaa5e5468aaf0e851e6e29b1b4.png
[269b0cecb919464f806a9596893c991d.png]: https://img-blog.csdnimg.cn/269b0cecb919464f806a9596893c991d.png
[90bad0cea84e40628338547f9bbc4647.png]: https://img-blog.csdnimg.cn/90bad0cea84e40628338547f9bbc4647.png
[8f000b8b11404a498613d6cc4b1f71d3.png]: https://img-blog.csdnimg.cn/8f000b8b11404a498613d6cc4b1f71d3.png
[6d81e891c9df404fa559e389775dd733.png]: https://img-blog.csdnimg.cn/6d81e891c9df404fa559e389775dd733.png
[40d38b3c43e64581bd6eeebaadec4960.png]: https://img-blog.csdnimg.cn/40d38b3c43e64581bd6eeebaadec4960.png