IDEA使用说明
文章树列

idea使用指南

 

 

IntelliJ IDEA为类和方法自动添加注释

阅读目录:

 

1、为类添加自动注释模版

2、为方法添加自动注释模版

阅读正文:

 

回到顶部

 

1、为类添加自动注释模版

File–>Settings–>Editor–>File and Code Templates

 

img

 

复制代码

 

1

2

3

4

5

6

7

/**

 * @author     :mmzs

 * @date       :Created in ${DATE} ${TIME}

 * @description:${description}

 * @modified By:

 * @version:     $version$

 */

复制代码

 

此时,当你创建新的类时,就会自动生成注释了。

 

注意:一定要启用该模板才有效

 

img

 

如果还不行,就添加如下设置:

 

img

 

回到顶部

 

2、为方法添加自动注释模版

File–>Settings–>Editor–>Live Templates

 

img

 

点击”+”号后,选择”Templates Group…”

 

img

 

img

 

img

 

注意:此处一定要为刚刚的模板指定使用范围:

 

img

 

例如:我指定的是java

 

img

 

注释模板填写内容参考如下:

 

1

2

3

4

5

6

7

8

9

10

11

/**

* 显示所有企业信息

*

* @param request

* @param response

* @return String

* @Type:EnterpriseController.java </p>

* @Description: 显示所有企业信息</   p>

* @author ny

* @date 2019年04月16日 下午05:30:32

*/

1

2

3

4

5

6

7

8

/**

 * create by: mmzs

 * description: TODO

 * create time: $date$ $time$

 * 

 $params$

 * @return $return$

 */

img

 

params的Exception内容如下:

 

1

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) ? '\\n'+'\\b' : '')}; return result", methodParameters())

点击Ok。

 

此时,在方法体内部输入add+Tab就可以生成注释了。

 

版本2

1、设置类注释模板

这里写图片描述

这样在定义类时,都要多输入类的描述。不想的话,可以删去 ${description}

 

2、方法注释模板

先新建模板组,名字自己起。

这里写图片描述

 

然后选中自己的模板组,在模板组下新建模板

这里写图片描述

 

如下图给模板设置信息

这里写图片描述

 

1、设置模板名称,建议不要换,就是 * 号

2、模板描述,可以没有

3、模板,注意开头是没有 /* 的

1

2

3

4

5

6

7

*功能描述  

* @author qqg 

* @date $date$ 

* @param $params$  

* @return $return$ 

*/

4、添加模板生成的地方,点开选择java或者全部都可以

5、设置模板快捷键,我设置为回车

6、编辑模板中的参数

这里写图片描述

 

7、点apply完成

8、用法:跟原来的一样: /** + 回车 即可,这就是我为什么取名为 * 的好处。

4、细节修改

可以看到生成模板的参数时,不是很好,是数组的,要做一下修改

1、模板改为:

1

* *功能描述  * @author qqg * @date $date$ $params$  * @return $return$ */1234567

2、添加 $params$ 参数分割

这里写图片描述

即:

 

1

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) ? '\\n':'')}; return result", methodParameters())1

1

新版下载
本文原创,商业转载请联系作者获得授权,非商业转载请注明出处。

评论

发送评论 编辑评论


                        

软件相关分类热门文章

标签热门文章排行

☛免责声明 ☛本站使用教程
Theme Argon With Ry-Plus By 清欢
我的第24569位朋友,历经142822次回眸才与你相遇
内容失效/资源代找/交流学习
内容失效/资源代找/交流学习