【idea插件】Easy Javadoc插件的使用说明

---

说明

	使用idea进行代码开发时，对于快速生成类或方法注释，有两种选择，一种是使用idea设置中的live template功能进行自定义的注释模板；另一种是使用idea的插件Easy Javadoc来实现。
	使用自定义注释模板方法仅支持生成简单的注释，使用插件则能够生成复杂的注释信息，这里介绍一下使用EasyJavadoc插件的配置方法。

---

一、安装Easy Javadoc插件

在idea的File-Settings-Plugins中搜索Easy Javadoc插件，点击install进行安装，安装完成后需要restart IDE，重启后插件生效。

二、配置注释模板

在idea的File-Settings-Ohter Settings-EasyJavadoc中，更改类相关设置：1.将作者改为自己的名称；2.将日期格式改为自己公司统一使用的格式 如 yyyy/MM/dd HH:mm。

类注释模板配置：打开折叠的下级目录，选择类注释模板配置，将文档注释格式勾选为自定义，并在模板框内容中配置如下

/**
* 类功能描述：
*
* @author $AUTHOR$
* @date $DATE$
*/

方法注释模板配置：打开折叠的下级目录，选择方法注释模板配置，将文档注释格式勾选为自定义，并在模板框内容中配置如下

/**
* 功能描述：
* $PARAMS$ 
* $RETURN$ 
* @author $AUTHOR$
* @date $DATE$
*/

三、使用方法

快速生成注释的使用方法：将光标至于需要生成注释的类名或方法名上，按快捷键 Ctrl + \ 组合键即可生成对应的注释。
效果: