ideal中java设置注释模板

147 阅读1分钟

本文已参与 「新人创作礼」活动,一起开启掘金创作之路。

1 类头注释编辑

打开设置面板,然后填写注释模板:

File => setting => editor => File and Code Templates

/**
* TODO 类描述
* @author 自己名字
* @date DATE{DATE} {TIME}
*/

2 属性注释/方法注释创建流程编辑

2.1 第一步勾选Enable Live Templates

File => setting => editor => File and Code Templates

2.2 第二步新建一个Group

https://img-blog.csdnimg.cn/20200908110116118.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQzMzExMzg=,size_16,color_FFFFFF,t_70

https://img-blog.csdnimg.cn/20200908110139293.png

2.3 第三步新建一个Template

选中新建的group,也就是选中chenjieGroup,在这个group下新建一个LiveTemplate

2.3.1 方法注释

**
* 功能描述
*
paramsparams
* @return returnreturn
* @author Anna.
* @date datedate timetime
*/

https://img-blog.csdnimg.cn/20200908111013287.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQzMzExMzg=,size_16,color_FFFFFF,t_70

https://img-blog.csdnimg.cn/20200908111404327.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQzMzExMzg=,size_16,color_FFFFFF,t_70

(1)如果param参数使用默认的methodParameters()来获取方法参数值,其注释参数是在一行展示的,如下图。这里我们希望像MyEclipse中一样,一行一个参数的样式,可以通过脚本来实现。将以下脚本复制进Expression,可以得到文章开头效果图的样式:

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

(2)如果return参数使用默认的methodReturnType()来获取参数值,模板里使用了@link来跳转结果类型,那么当方法返回值为void时,注释会报错,如下图。可以通过脚本来避免,将上面模板中的@link参数去掉,将以下脚本复制进Expression: 

 groovyScript("def result=\"${_1}\"; if(result == \"void\"){return \"\";}else{return \"{@link \"+result+\"}\";}", methodReturnType()) 

属性注释设置

相当与重新添加一个模块,设置如下:

**
*
* TODO 属性描述
*/

https://img-blog.csdnimg.cn/20200908111823910.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQzMzExMzg=,size_16,color_FFFFFF,t_70

3 使用方法编辑

与常用操作快捷方式一样

属性注释: “/*” + enter

方法注释: “/**” + enter