idea java 注释模板_IntelliJ IDEA 符合 JavaDOC 的注释模板设置方法

类注释模板:

/*** @version 0.1.0** @author your name or email** @since 0.1.0** @create ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}**/

IDEA 设置方法:

按照如下导航找到位置粘贴 Template, 修改 Author 为自己

Setting > Editor > File and Code Templates > Includes > File Header

方法注释模板:

*

* $description$

$params$

* @version 0.1.0

* @return $returns$

* @author Your name or email

* @date $date$ $time$

* @since 0.1.0

*/

IDEA 设置方法：

按照如下导航找到位置:

Setting > Editor > Live Templates

看到右边的 + 按钮，选择第二项 2. Template Group... Group 名字随便定义

增加好 Group 之后，点击选中自己添加的 Group，再点击右边的+选择第一项 1. Live Template

按照下图设置，其中 Abbreviation 是设置在生成注释之前需要输入的字符串，通常我们的操作习惯是输入 /** 然后回车，所以我这里设置了 *

Edit variables 按钮是设置模板中使用 $$ 括起来的变量，有很多选项，其中 $description$没有设置，有了这个标志当我们生成注释之后光标直接跳到描述位置等待你输入描述内容

$params$ 设置为

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

下面的 Applicable 是设置对哪些语言生效，默认选择全部就行

右边 Expand With 是设置按下哪个按键生成注释，按照习惯通常选择 Enter

随着时间推移，一个方法会被多个人修改，@author 就需要添加多行，并注明修改时间和修改内容，同时对 @version 要加 0.0.1 例如：

/*** Submit a POP request* @version 1.0.2* @since 0.1.0* @param token Token* @param command Data Post* @return com.lenovo.mds.common.response.JsonBody* @author User A* @author User B XXXX-XX-XX 这里是 B 修改的内容* @author User C XXXX-XX-XX 这里是 C 修改的内容* @date 2019-08-04 00:00*/