Intellij IDEA 自定义注释模板在方法上得到参数和返回值

╰+攻爆jí腚メ 2022-04-17 05:24 439阅读 0赞

# 说明 #

之前配置的注释模板在方法上得不到参数和返回类型，在网上找了好多方法，如在param和returnType设置groovyScript脚本，但仍然无法获取。最后找到资料，发现是模板格式设置错误，在这里记录下。

# 正文 #

如何创建Live Templates就不在此介绍了。直接介绍方法注释模板的设置：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NpbmF0XzM2NTUzOTEz_size_16_color_FFFFFF_t_70]  
如图所示，直接名称为\* 的模板，这个模板中有三个参数需要设置：@Date,@Param,@Return，在这里强调下，模板的名称必须为\* ，模板格式必须是以单个\*开头  
**模板格式**

*
     * @Author: wds
     * @Description:
     * @Date: $time$ $date$
     * @Param: $params$
     * @Return: $return$
     */

编写好模板后，通过Edit variables设置模板参数  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NpbmF0XzM2NTUzOTEz_size_16_color_FFFFFF_t_70 1]

注意 这里的Expand with 决定了你可以使用什么方式使用模板，这里默认是Enter,也就是回车键。  
保存后在方法上通过\\\* + 模板名称 + Enter,也就是 \\\* +\* + Enter就可以得到设置好的注释信息

参考资料：  
[https://blog.csdn.net/u014044812/article/details/76577479][https_blog.csdn.net_u014044812_article_details_76577479]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NpbmF0XzM2NTUzOTEz_size_16_color_FFFFFF_t_70]: /images/20220417/a74d6ccb7ab4465dafe47c07dc20eccd.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NpbmF0XzM2NTUzOTEz_size_16_color_FFFFFF_t_70 1]: /images/20220417/56429b47231f4a0cb94ec79b489dc085.png
[https_blog.csdn.net_u014044812_article_details_76577479]: https://blog.csdn.net/u014044812/article/details/76577479