IDEA使用总结（三）：添加注释模板

叁歲伎倆 2022-12-19 03:38 94阅读 0赞

### 添加注释模板 ###

*   *  生成类注解模板
     *  生成方法注解模板
     *  使用插件

## 生成类注解模板 ##

File -> Settings -> File and Code Templates -> Includes -> File Header -> 编辑

/** * @program: ${PROJECT_NAME} * * @description: ${description} * * @author: Ameng * * @create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE} **/

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODkyNDUwMA_size_16_color_FFFFFF_t_70_pic_center]  
点击Apply和ok。

或者直接在类模板中添加，去除引用的文件。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODkyNDUwMA_size_16_color_FFFFFF_t_70_pic_center 1]

## 生成方法注解模板 ##

File -> Settings ->Editor->Live Templates

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODkyNDUwMA_size_16_color_FFFFFF_t_70_pic_center 2]

** 
    * @Description: $description$ 
    * @Param: $params$ 
    * @return: $returns$ 
    * @Author: Ameng
    * @Date: $date$ 
    */

这里不仅可以定义方法的注释模板，还可以自定义自己的输出或者编写代码的快捷输出。注意修改完后要勾选statement，否则不生效。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODkyNDUwMA_size_16_color_FFFFFF_t_70_pic_center 3]

## 使用插件 ##

在 File -> Settings -> Plugin 中搜索 javadoc2，点击安装，重启 Intellij IDEA。  
![加粗样式][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODkyNDUwMA_size_16_color_FFFFFF_t_70_pic_center 4]  
在 settings 中找到 javadoc2，根据自己需要进行设置调整

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODkyNDUwMA_size_16_color_FFFFFF_t_70_pic_center 5]

选中要生成 javadoc 注释的包或文件，右键，在弹出菜单中，选择 JavaDocs -> Create JavaDocs for all elements

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODkyNDUwMA_size_16_color_FFFFFF_t_70_pic_center 6]  
生成的效果  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODkyNDUwMA_size_16_color_FFFFFF_t_70_pic_center 7]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODkyNDUwMA_size_16_color_FFFFFF_t_70_pic_center]: /images/20221120/d884f8cbe71e4163ab36cfd7637540ba.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODkyNDUwMA_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221120/6b31f44ef3b64ecea3a65137a035d40e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODkyNDUwMA_size_16_color_FFFFFF_t_70_pic_center 2]: /images/20221120/c907b16903c24818a47377ebccf77107.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODkyNDUwMA_size_16_color_FFFFFF_t_70_pic_center 3]: /images/20221120/478f20d98588432b8cfe2231d3076d7e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODkyNDUwMA_size_16_color_FFFFFF_t_70_pic_center 4]: /images/20221120/69e709301090485daeff7f6a8a46e09b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODkyNDUwMA_size_16_color_FFFFFF_t_70_pic_center 5]: /images/20221120/06ba301a9a9f4ccd98f294d47009f7d5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODkyNDUwMA_size_16_color_FFFFFF_t_70_pic_center 6]: /images/20221120/f71b1dfc9826477cb4accc9f9705caa7.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODkyNDUwMA_size_16_color_FFFFFF_t_70_pic_center 7]: /images/20221120/9a3d47b15e974e85b7f5b60aa966c880.png