在 IntelliJ IDEA 中设置函数的 JavaDoc 注释模板的办法

灰太狼 2021-09-25 05:14 376阅读 0赞

### 在 IntelliJ IDEA 中设置函数的 JavaDoc 注释模板的办法 ###

> 笔者的工作环境：  
> JDK 13.0.2  
> IntelliJ IDEA 2020.1.2 (Ultimate Edition)

1.  如图示操作：

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

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmdwYWlibG9n_size_16_color_FFFFFF_t_70_pic_center 1]

1.  在 Abbreviation（缩写）中输入自己想进行的设置，这个设置将成为后面的快捷键的一部分。这里设置的 Abbreviation 为 \* 。

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

1.  在 Template text 中输入自己想设置的 javadoc 模板，这个模板必须去掉最前面的 /，因为 / 是后面的快捷键的一部分。一个 Template text 中的示例如下：
    
        **
         * 
         * 
         * @param 
         * @return 
         * @throws 
         * 
         * @implSpec 
         * @apiNote 
         * @implNote 
         * 
         * @since 
         */

注意，一般的方法注释中，最下面的\*与方法头之间是有一个空格的。如下图所示：

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

但是，后面的快捷键的输入，会事先插入一个 / 符号，这会导致在输入快捷键的那一行首先产生一个 / 符号，从而占据一个字符的位置，因此，上面 Template text 中，从第二行开始的 \* 需要与第一行的第二个 \* 对齐。如下图所示：

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

1.  在图片中的 `Define`中选择模板需要应用的场景。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmdwYWlibG9n_size_16_color_FFFFFF_t_70_pic_center 3]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmdwYWlibG9n_size_16_color_FFFFFF_t_70_pic_center 4]

1.  在保存上面的设置之后，回到自己的编程界面，在需要编写 javadoc 注释的方法上面输入如下快捷键：`/` \+ `前面设置的 Abbreviation` \+ `Tab键`。比如，这里的快捷键为：`/` \+ `*` \+ `Tab键`。在输入快捷键之后，自己在前面设置的 Template text 就会马上自动生成：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmdwYWlibG9n_size_16_color_FFFFFF_t_70_pic_left 1]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmdwYWlibG9n_size_16_color_FFFFFF_t_70_pic_center]: /images/20210923/ebbc068ae24e4ef08e68d26f31516672.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmdwYWlibG9n_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20210923/85c17c0b2b9d478b851039fa03ba2c5e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmdwYWlibG9n_size_16_color_FFFFFF_t_70_pic_center 2]: /images/20210923/b615aec62f8048369a89dccef8dca0fc.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmdwYWlibG9n_size_16_color_FFFFFF_t_70]: /images/20210923/13815a6c18bd44a38e43251b6938c2ad.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmdwYWlibG9n_size_16_color_FFFFFF_t_70_pic_left]: /images/20210923/410d793bcb754a469d8fd84347ed3ccd.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmdwYWlibG9n_size_16_color_FFFFFF_t_70_pic_center 3]: /images/20210923/fdb3dc372b8240f1804b99d9c36bef1e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmdwYWlibG9n_size_16_color_FFFFFF_t_70_pic_center 4]: /images/20210923/7d0d2a284348491ba465916b7e7db8a3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmdwYWlibG9n_size_16_color_FFFFFF_t_70_pic_left 1]: /images/20210923/7b832fa2229c448b97e3b2c38efa9fbc.png