idea 2018.2.4 创建自定义的java方法注释和类注释

以下内容是通过自己百度和自己实践得到的经验，如有疑问或其他，请联系我：QQ246669289  谢谢

---

首先打开 idea ，然后在左上角找到 File -->  Settings --> Editor --> File and Code Templates

然后在侧面找到class，有两种添加方式，①直接在当前的模板内添加对应的注释（如上图）

或者②找到下图所在位置，添加注释代码块

我用的注释模板是：

/**
 * @ClassName ${NAME}
 * @description ${DESCRIPTION}
 * @author 侯少
 * @date ${DATE} ${TIME}
 * @modifier 侯少
 * @date ${YEAR}-${MONTH}-${DAY} ${TIME}
 * @Version V1.0
 */

注：
① 可以使用${DATE}让其生成日期格式为 yyyy/MM/dd 格式的日期，也可以使用下面
${YEAR}-${MONTH}-${DAY}
这种手动修改想要的日期格式
② 可以通过在file下面的class选项内设置 ${DESCRIPTION} ，使在创建类的时候就可以填写该类的作用

因为用的是公司电脑，直接让其读取电脑的用户和我本人姓名不一致，这里直接添加自己的名字

添加完自己想要的注释后，apply --> ok  就可以了

 

接下来开始自定义方法的模板

File -->  Settings --> Editor --> Live Templates  -->  + --> Templates Group...  -->  添加自己定义的方法名，然后选中该新定义的方法，后选择右侧的  1 Live Templates --> 在下图中6号框的位置添加生成注释前面的代码（譬如我这里使用的是“hou”，当我在代码输入hou后点击回车或者tab时，便会生成我要的注释），同时可以在右侧写上这个快捷注释是做什么的，

然后在底部框内添加注释的模板代码，在模板代码底部选择当前注释模板适用类型，我选择了java，

添加完注释模板后我们要给每个添加相应的函数，此时我们选择edit variables 

在对应下拉选择框的里面选择我们要的函数，对于日期类，我个人不太习惯它自动生成的 2019/4/23的样式，所以我在date()内添加了我要的它展示的样式，设置好以后点击ok（这一步一定要设置，不然$$内的函数不生效）

然后apply --> ok

以下是我自己设置的方法注释的代码模板：

/**
 * @Title $methodName$
 * @description TODO
 * @author 侯少
 * @date $DATE$ $time$
 $params$ 
 * @return $return$
 * @throws $throws$
 */

注： 参数的设置部分需要使用到 groovyScript 函数，配合下面的代码一起使用，将其复制粘贴到Default value一栏即可：

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())

下面是效果图：

 

注：

可能设置好 类注释 以后，自动生成时，作者会跑到类名的前面去，此时将

下图中的选项前面取消勾选，就可以了

注释中关于异常的获取还待完善，等亲身试验好了后再进行教程上传