IntelliJ IDEA自定义方法注释模板含消除警告方法

- 日理万妓 2022-03-14 09:26 930阅读 0赞

1、文件->设置->编辑器->代码模板

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzE2NTAzMDQ1_size_16_color_FFFFFF_t_70][]

2、点击右上角的绿色+号，然后选择template group ，然后输入group的name，随便输入就好了：myGroup。然后点ok

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzE2NTAzMDQ1_size_16_color_FFFFFF_t_70 1][]

3、选中刚才创建的myGroup，然后再次点击右侧的绿色+，这次选择的是第一个1. Live Template。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzE2NTAzMDQ1_size_16_color_FFFFFF_t_70 2][]

4、配置模板，下面是我的模板，大家仔细看我的模板开头是\*而不是/\*,这就是关键所在。（注意只有当变量被$$包围是 右侧的Edit variables才可以点击哦。）

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzE2NTAzMDQ1_size_16_color_FFFFFF_t_70 3][]

在方法头部输入 /\*\* 然后按 tab 键，自动生成注释

\*  
\*  
\*  
\* @author Dongyun  
\* @date $date$ $time$  
\* @param $params$  
\* @return $return$  
\*/

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzE2NTAzMDQ1_size_16_color_FFFFFF_t_70 4][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzE2NTAzMDQ1_size_16_color_FFFFFF_t_70 5][]

5、完成之后点击Apply然后点击OK，注意了，重点的地方，在你的方法上输入 /\*然后加上模板的名称\*，这就是我为什么不取字母而取名为\*，因为这样很快速，**再按Tab键（注意啊不是按Enter键，而是按Tab键）**就会出现你想要的注释了，很多教程是直接输入模板名称按tab键，但是这种方法的@param和@return是获取不到的，**再重复一遍正确的方式**：/\*\* 然后按Tab键；如果你取名为abc那就是 /\*abc 然后按Tab。

6、但是还有两个问题：

（1）@param这个参数上报错了，这是因为idea强大的检查功能。

解决方案：File->settings->Editor->Inspections->javadoc issues下面第四项将红色 Error改为黄色Warning即可

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzE2NTAzMDQ1_size_16_color_FFFFFF_t_70 6][]

（2）@description、@date这两个参数上报警告了；另外如果参数报警告，则需要在参数后面加描述，如**@param \[user\] 用户实体类**

javadoc标签填写：description,date,param,return,exception,throw

解决方案：在设置中添加javadoc即可，如下图。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzE2NTAzMDQ1_size_16_color_FFFFFF_t_70 7][]

7、最终注释的样子

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzE2NTAzMDQ1_size_16_color_FFFFFF_t_70 8][]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzE2NTAzMDQ1_size_16_color_FFFFFF_t_70]: /images/20220313/72ac6f162b094150a51bc9bc82a9a4a9.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzE2NTAzMDQ1_size_16_color_FFFFFF_t_70 1]: /images/20220313/4d55542c40e5497dbd211abe554377f4.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzE2NTAzMDQ1_size_16_color_FFFFFF_t_70 2]: /images/20220313/2dad019636334b8f88d20618c5c41a04.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzE2NTAzMDQ1_size_16_color_FFFFFF_t_70 3]: /images/20220313/308e344f5e564f1990940fbddfa7ef58.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzE2NTAzMDQ1_size_16_color_FFFFFF_t_70 4]: /images/20220313/f669b86525b44551aa7cf00d6c5dc45b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzE2NTAzMDQ1_size_16_color_FFFFFF_t_70 5]: /images/20220313/6c0a45cb2155445b89d14bdff57fb350.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzE2NTAzMDQ1_size_16_color_FFFFFF_t_70 6]: /images/20220313/a228e4e0e99f484281fc72f32750104f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzE2NTAzMDQ1_size_16_color_FFFFFF_t_70 7]: /images/20220313/faefbabeae4a449eb2978f338f86f1cb.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzE2NTAzMDQ1_size_16_color_FFFFFF_t_70 8]: /images/20220313/271f9f39231e418885b4af8754962967.png