设置Idea类注释模板和方法注释模板

https://blog.csdn.net/u011961421/article/details/78773665

网上找了一下，没有很详细且正确介绍Idea配置注释模板的，于是结合多篇文章自己琢磨整理出如下。

设置类注释模板

1.选择File–>Settings–>Editor–>File and Code Templates–>Includes–>File Header. 

2.在右边空白处，编写自己的模板即可，注意Scheme是模板的生效范围，可选变量在description有介绍，附图中本人使用的模板（${USER}为计算机用户名，可以自行修改）。

/**
 * @Auther: ${USER}
 * @Date: ${DATE} ${HOUR}:${MINUTE}
 * @Description: 
 */

3.设置完成后，创建类时自动生成注释，效果如下。 

设置方法注释模板

https://blog.csdn.net/u014044812/article/details/76577479/

1. File->settings->Editor->Live Templates
   
   
    
2. 点击右上角的绿色+号，然后选择template group ，然后输入group的name，随便输入就好了：myGroup。然后点ok
   
   
    
3. 选中刚才创建的myGroup，然后再次点击右侧的绿色+，这次选择的是第一个1. Live Template。取名为*，取名可以随便，只是个人觉得方便，你可以取别的。
    
   
    
4. 配置模板，下面是我的模板，大家仔细看我的模板开头是*而不是/*,这就是关键所在。
    

   1. *

   2. *

   3. *

   4. * @author chenmc

   5. * @date $date$ $time$

   6. * @param $params$

   7. * @return $returns$

   8. */

   注意：只有当变量被$$包围时 右侧的Edit variables才可以点击哦。
   
    
5. 再编辑好模板之后就只为参数添加$$添加变量，点击右侧的 Editor variables，
   
   
    
6. 完成之后点击Apply然后点击OK，注意了，重点的地方，在你的方法上输入 /*然后加上模板的名称*，这就是我为什么不取字母而取名为*，因为这样很快速，再按Tab键（注意啊不是按Enter键，而是按Tab键）就会出现你想要的注释了，很多教程是直接输入模板名称按tab键，但是这种方法的@param和@return是获取不到的，再重复一遍正确的方式：/** 然后按Tab键；如果你取名为abc那就是  /*abc 然后按Tab。效果如下：
   
   
    
7. 但是还有一个问题，细心的读者会发现在@param这个参数上报错了，这是因为idea强大的检查功能，有两种解决办法:
    

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

   

   第二种是点击idea的右下角的人头图像，然后选择高亮级别，调为Syntax模式即可

   
   
   
   至此已大功告成了，希望能帮到大家！