IDEA自定义JavaDOC注释模板

朴灿烈づ我的快乐病毒、 2024-03-30 10:31 6阅读 0赞

#### 文章目录 ####

*  IDEA自定义JavaDOC注释模板
 *   *  方法注释模板
     *   *  1、创建模板
         *  2、设置模板内容-JavaDoc格式
         *  3、Define
         *  4、Edit Variables

## IDEA自定义JavaDOC注释模板 ##

JavaDOC注释模板共分为两种：

1.  类注释模板
2.  方法注释模板

### 方法注释模板 ###

#### 1、创建模板 ####

File–>Settings–>Editor–>Live Templates

点击 “+” 号，选择 “Template Group” 新建组。然后填写自己定义的组名称，点击“OK”。如下图所示：

![在这里插入图片描述][68822db3ee0146b98aa81d9610c73176.png]

选中新建的组，再点击 “+” ，新建"Live Template"。然后填写信息。如下图所示：

注意点：

1.  Abbreviation填写 `*`
2.  Expand with 快捷键设置为 `Enter`

![在这里插入图片描述][e942b13c82584007be071825a3a46095.png]

#### 2、设置模板内容-JavaDoc格式 ####

注意：如果您的Abbreviation设置为如上图所示的`*`,template模板如下面所示：

*
     * @description TODO the method is used to
     * @author 阿凡达
     * @date $time$ $date$ $param$ $return$
     */

#### 3、Define ####

点击`Define`按钮（如果是修改则点击`change`）

![在这里插入图片描述][78e10901afb94be5a74fdb59fc4a6324.png]

弹出的对话框中选择java

![在这里插入图片描述][b3bf9295826243b08352278c72d9dc33.png]

#### 4、Edit Variables ####

注意：必须先进行第三步，再进行第四步  
![在这里插入图片描述][79d44cf4136a489a9d27461e5736772f.png]

JavaDoc格式的需要自定义参数以及返回值的实现方式:

**获取参数实现方式：**

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

返回值实现方式：

groovyScript("return \"${
          _1}\" == 'void' ? null : '\\r\\n * @return ' + \"${
          _1}\"", methodReturnType())

如下图：

![在这里插入图片描述][efbfc79d63eb498a83233a053eba4ef2.png]  
效果图如下：

![在这里插入图片描述][661213b108164201b0f9e749be6bda47.png]

[68822db3ee0146b98aa81d9610c73176.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/b79819a5002c443cbe42ab79c89ba456.png
[e942b13c82584007be071825a3a46095.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/cb82e850f10646e4bf319561d225220c.png
[78e10901afb94be5a74fdb59fc4a6324.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/4a786abaeab9470bb68e08e7032ec007.png
[b3bf9295826243b08352278c72d9dc33.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/88ed09e4cb5c472e92d1dab7ec4f960e.png
[79d44cf4136a489a9d27461e5736772f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/d6553617579c4550aa29fa52aa61c49a.png
[efbfc79d63eb498a83233a053eba4ef2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/baa789850efc48dd937bb2e8651ab9d7.png
[661213b108164201b0f9e749be6bda47.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/24edb3ca29584638a604ec02e5650eb2.png