IDEA插件系列（3）：Easy Javadoc插件——快速生成javadoc文档注释

男娘i 2024-03-31 16:58 131阅读 0赞

### 1.插件介绍 ###

**Easy Javadoc插件。**

能帮助开发者快速生成类、方法、属性等中文javadoc  
![在这里插入图片描述][107044c93499416282c763fe053350b2.png]

### 2.安装方式 ###

第一种安装方式是在线下载安装插件。  
![在这里插入图片描述][806519ed4a774a2ea8275fc811360c77.png]  
第二种安装方式是使用离线插件进行安装。

插件下载地址：[https://plugins.jetbrains.com/plugin/12977-easy-javadoc][https_plugins.jetbrains.com_plugin_12977-easy-javadoc]  
![在这里插入图片描述][58be45cdc1a348229cd9c3204520c116.png]

### 3.使用方法 ###

可以直接查阅[官方的使用说明][Link 1]，是中文文档。

##### 默认快捷键（可通过IDEA快捷键设置修改） #####

###### win ######

<table> 
 <thead> 
  <tr> 
   <th>快捷键</th> 
   <th>作用域</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>ctrl \</code></td> 
   <td>类、方法、属性（光标放上面就行，不要双击选中！）</td> 
   <td>生成当前文档注释</td> 
  </tr> 
  <tr> 
   <td><code>ctrl \</code></td> 
   <td><strong>选中的</strong>中文</td> 
   <td>生成选中的中文的英文命名</td> 
  </tr> 
  <tr> 
   <td><code>ctrl \</code></td> 
   <td><strong>选中的</strong>非中文</td> 
   <td>弹框展示翻译结果</td> 
  </tr> 
  <tr> 
   <td><code>ctrl shift \</code></td> 
   <td>类</td> 
   <td>生成全部文档注释</td> 
  </tr> 
 </tbody> 
</table>

###### mac ######

<table> 
 <thead> 
  <tr> 
   <th>快捷键</th> 
   <th>作用域</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>command \</code></td> 
   <td>类、方法、属性（光标放上面就行，不要双击选中！）</td> 
   <td>生成当前文档注释</td> 
  </tr> 
  <tr> 
   <td><code>command \</code></td> 
   <td><strong>选中的</strong>中文</td> 
   <td>生成选中的中文的英文命名</td> 
  </tr> 
  <tr> 
   <td><code>command \</code></td> 
   <td><strong>选中的</strong>非中文</td> 
   <td>弹框展示翻译结果</td> 
  </tr> 
  <tr> 
   <td><code>command shift \</code></td> 
   <td>类</td> 
   <td>生成全部文档注释</td> 
  </tr> 
 </tbody> 
</table>

注意，需要将光标放在方法名、变量名、类名的字符串中间（不要选中，因为选中会变成编译该单词）再按快捷键才会生效。如下图：  
![在这里插入图片描述][ad9dc2c83e754f6ab2b9a1adf6fd86fb.png]  
可以对文档注释中的作者名、日期格式等进行相关设置，还可以设置翻译媒介（如百度翻译、有道翻译等）。  
![在这里插入图片描述][8115d918b16940c1ab069e4b689a92ff.png]  
类注释模版

/**
     * 类名称：$CLASSNAME$
     *
     * 描述：$DOC$
     * 创建人: $AUTHOR$ 
     * 创建时间: $DATE$
    */

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

方法注释模版

/**
     * $DOC$
     *
     * $PARAMS$ 
     * $RETURN$
     * @author $AUTHOR$ 
     * @date $DATE$
    */

![在这里插入图片描述][0ec3a00726344580a13eb1da3b3f7d4d.png]  
如果它们的快捷键发生冲突，可以在Keymap（按键映射）面板中进行修改。  
![在这里插入图片描述][2ebb6682a54b4811b916d79b2b523ad1.png]

[107044c93499416282c763fe053350b2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/47bcfdae847b458a80c9f822add32ed6.png
[806519ed4a774a2ea8275fc811360c77.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/94e6942f9292445881438c40d179959e.png
[https_plugins.jetbrains.com_plugin_12977-easy-javadoc]: https://plugins.jetbrains.com/plugin/12977-easy-javadoc
[58be45cdc1a348229cd9c3204520c116.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/e36c268114c34048b4309b0cd87b3259.png
[Link 1]: https://github.com/starcwang/easy_javadoc
[ad9dc2c83e754f6ab2b9a1adf6fd86fb.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/c3c28e58e1444209b805a91fb526c3b1.png
[8115d918b16940c1ab069e4b689a92ff.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/fc76e0697974422888eca74163bdf071.png
[9be712d8ff1445d39fe80b18165d47d9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/7b3f052f458a437e966ca541a89f7904.png
[0ec3a00726344580a13eb1da3b3f7d4d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/c0b9d1c038e446bfabb49ab9c3a3126b.png
[2ebb6682a54b4811b916d79b2b523ad1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/914c481d7a5849f1b496c3f8791ddd2f.png