JavaDoc的配置（idea版）

1. 点击左上角的File 选择Settings 打开设置页面 (或者直接按Ctrl + Alt + s 快捷键打开)

2. 在Settings 设置页面的 Editorlan 栏目下找到 Live Templatea 点击打开自定义注释设置页面

3. 点击列表右边的绿色+号会有两个选项: 1: Live Template (创建一个动态模板) 2: *Template Group... (添加一个模板类目)*

4. 点击*2:* Template Group... 创建了一个名为 zxl 的模板类目。在该类目下点击+号选择*1: Live Template 添加模板:*

5. 

6. Template text 内容如下:

   1. *
   2. \* 功能描述: 
   3. \* 〈$END$〉
   4. \* 
   5. $params$
   6. \* @return : $return$
   7. \* @author : zxl
   8. \* @date : $DATE$ $TIME$
   9. */

   (这里开头用了 * ,而没有使用 /** 是为了从函数外部调用 params 和 return , <$END$> 表示最后输入位置)

7.点击 Edit variables , 进行自定义参数配置

在这里我们把4个参数的 Skip if defined 都勾选上,是为了模板生成后直接跳转到功能描述:进行书写。

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

8.选择触发方式, 如 图-6 我们这里选择回车。最后依次保存配置 -> 完成!

使用方式: 在函数上一行输入/** + 回车 (无需输入函数名)输出如下:

/**
     * 功能描述: 注释的配置
     * 〈 正确使用javadoc格式进行注释 〉
     *
     * @param args 1
     * @return : void
     * @author : hxz
     * @date : 2020/12/4 9:55
     */