如何在 IntelliJ IDEA 中快速生成 JavaDoc 注释模板

笔者的工作环境：

• IntelliJ IDEA 2021.2.2 (Ultimate Edition)

• JDK 17

  使用 IntelliJ IDEA 中的实时模块可以快速生成 JavaDoc 注释。方法如下：（IntelliJ IDEA 在 2021 年之后的版本已经以插件的形式给出了 IntelliJ IDEA 的官方汉化版。该插件名为：Chinese (Simplified) Language Pack。因此本博客中 IntelliJ IDEA 的界面为中文版界面。）

1. 按下图所示点击。

   

2. 创建一个 模块组，模块组 的名称可以任意起，只要不与已有的重复即可。

   

   

3. 在模块组下添加一个 动态模板。

   

4. 选择此模板的生效场合。

   

   

5. 设置此动态模板的 缩写、快捷键 和 模块文本。笔者在本教程中使用的 模块文本 如下：

   /**
    *
    *
    * @param
    * @return
    * @throws
    *
    * @implSpec
    * @apiNote
    * @implNote
    *
    * @since
    */
   

   ---

   【原理】

     此动态模板的原理是，如果设置了上述动态模板的 缩写、快捷键 和 模块文本，当依次输入 缩写、快捷键 时，输入的 缩写 就会自动被替换成 模块文本 中的内容。

   ---

   

6. 由于笔者前面设置的 缩写 为 /，快捷键 为 Tab。因此笔者只需要在代码中依次输入 /、Tab 之后，就可以立即生成前面设置的 JavaDoc 了。

   

7. 还可以变得更方便。由于符号 / 在中文模式下输入后会变成 、，切换中英文稍有不便。如果同时也将 、 设置为 缩写，那么就无需切换中英文了。

   

   

8. 现在，依次输入 、、Tab 之后，也可以立即生成前面设置的 JavaDoc 了。