第一篇---IDEA添加类注释和方法注释【详细操作截图】

1,729 阅读3分钟

近期,同事换idea开发,被问到如何设置类注释和方法注释的快捷键,当时有点蒙,怎么不记得有快捷键呢? 后来回忆了一下,才想起相关配置及使用方法。这里做一下备忘,也给需要的同人们给个指点。

一、类注释 有两种方法: 第一种方法:在新建类时添加注释 打开【Settings】-【Editor】-【File and Code Templates】菜单,在Files标签下找到Class,左键单击,如下图

image.png 添加的就是红色框中的内容。其中@descriptions: ${description}这个,可以看情况。这里加上之后,在新建类的时候,会弹出两次输入框,第一次是类名,第二次就是这个description了,创建时会自己添加进去。使用和效果如下图

image.png

image.png

image.png

下面内容可以直接复制粘贴(@author处,修改为自己的名字,也可以添加user参数,作为@author的值)

 * @descriptions: ${description}
 * @author: 
 * @date: ${DATE} ${TIME}
 * @version: 1.0
 */

第二种方法:创建类后,追加注释 打开【Settings】-【Editor】-【Live Templates】菜单, 按照下图顺序完成操作 1:添加Template Group 2:添加Live Template 3:填写呼出快捷操作缩写(此项是快捷操作时如要输入的项) 4:填写快捷操作说明 5:填写快捷操作 6:选择作用域 7:配置参数 8:选择快捷键

image.png

左键单击右边“+”,添加Template Group

image.png

image.png

在新加的group中添加新的Live Template,左键单击右边的“+”

image.png 在Abbreviation中填入快捷操作缩写,在Description中填入快捷操作说明 在Template text中填入内容 下面内容可以直接复制粘贴(@author处,修改为自己的名字,也可以添加user参数,作为@author的值)

/**
 * @descriptions: TODO
 * @author: 
 * @date: $DATE$ $TIME$
 * @version: 1.0
 */

新创建的Live Template 需要配置define工作域,点击图中Dfine,弹出窗口选中Java或者Everywhere

image.png

image.png 配置参数的值

image.png 在Expression的下拉中选择上图中的项即可

操作及效果展示: 在我们需要添加类注释的地方,输入classdoc(就是我们配置的Abbreviation项),就会出现快捷操作的提示,选中点击Enter完成

image.png

image.png

二、方法注释 方法注释其实也是增加一个Live Template

image.png 相同的步骤就不多说了,只说关键地方 1、Abbreviation输入,快捷键选Enter,这样是为了使用 /** + Enter 来添加方法注释 2、Template text 输入的不要以 /* 开头 下面内容可以直接复制粘贴(@author处,修改为自己的名字,也可以添加user参数,作为@author的值)

*
 * @descriptions 功能描述 
 * @author 
 * @date $date$ $time$
$params$ 
 * @return $return$
 */

3、参数配置时,需要把params的Expression填入下面的内容,否则参数会被放到一个数组中而不是一个一个的@param 标注

image.png 下面内容可以直接复制粘贴

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

此时在方法处通过使用 /** + Enter 方式,就可以添加如下效果的方法注释了

image.png 如果这里param配置成下图这样,

image.png 参数就会变成数组一样的情况,如果你的是类似的情况,就参考上面的操作修改一下就好了

image.png 好了,类和方法的注释就添加完成了,愉快的享受IDEA给你带来的编程乐趣吧。 其实这些都是javadoc规范里的东西,可以通过此链接Javadoc 使用详解查看javadoc的相关信息.