在Idea中配置类和方法的注解模板

一.在idea中配置类的注解规范

1.1 idea中配置类的注解

1. 在idea中，选中file-------settings-----editors-----file and code Templates 下选择，Class，在右边填写注解：，内容，

2. /**
   *@ClassName: ${NAME}
   *@Description: TODO
   @Author: liujianfu
   @Date: ${YEAR}/${MONTH}/${DAY} ${HOUR}:${MINUTE}:${SECOND} 
   @Version: V1.0
   **/

1.2 idea中配置方法的注解

1. 在idea中，选中file-------settings----->editors-----Live Templates下自定义MyDefineKey，在右边填写注解：内容，如下图：

1. 点击右边的加号，选择Template Group，创建一个分组：

 

2.再点击加号，选择Live Template，创建一个模板，输入内容如下：

*
* @author liujianfu
* @description       
* @date $date$ $time$
* @param $params$        
* @return $returns$
*/

3.点击模板页面最下方的警告define，来设置将模板应用于哪些场景，选择Everywhere-->Java即可

 4.点击Edit variables，会读取刚刚在注释模板中的配置的参数${参数名}$。在Expression的下拉框中选择方法为其赋值。

5.将默认的tab键改为enter键

6.演示调用注解

输入“/** ”  然后按住enter键，

7. 但是还有一个问题，细心的读者会发现在@param这个参数上报错了，这是因为idea强大的检查功能，解决办法如下：

file-------àsettings-----àInspections------àjava---àjavadoc 下第4行，将红色选中为黄色警告。