IDEA中注释相关配置

IDEA中注释相关配置，以便于快捷开发

1、新建类时的相关注释快速配置

打开IDEA点击

file->setting->Editor->Filr and Code Templates->Includes->File Header

在右侧文本框中输入相关注释模板

/**

* @Description: ${类描述}

* @ProjectName: ${PROJECT_NAME}

* @ClassName: ${TYPE_NAME}

* @Author: ${user}

* @CreateDate: ${DATE} ${TIME}

* @UpdateUser: ${user} →→→ 每次进行代码修改根据实际情况进行更新

* @UpdateDate: ${DATE} ${TIME} →→→ 每次进行代码修改根据实际情况进行更新

* @Version: 1.0 →→→每次进行代码修改根据项目版本号进行升级

*/

该配置将于类新建时直接进行添加。

2、设置注释相关的快捷输入方式

打开IDEA点击

file->setting->Editor->LiveTemplates

新建Template Group

创建私有化模板组根据个人需要进行命名

选择刚刚新建模板组

分别新建如下几个模板

如上图，点击1处对选中的模板组提价模板

2处填写所需要的模板快捷字符集

3处为该模板的描述

4处为模板实体根据不同的需求填写不同的模板5处为，该模板的作用范围点击选择相关使用环境6处对模板中需要使用到的参数进行配置

⑴当前类注释

/**

* @Description:

* @ProjectName: $PROJECT_NAME$

* @ClassName: $TYPE_NAME$

* @Author: 作者名

* @CreateDate: $DATE$ $TIME$

* @UpdateUser: 作者名

* @UpdateDate: $DATE$ $TIME$

* @Version: 1.0

*/

⑵当前方法注释

/**

* @Description:

$params$

* @Author: 作者名

* @CreateDate: $DATE$ $TIME$

* @UpdateUser: 作者名

* @UpdateDate: $DATE$ $TIME$

* @Note:

*/

其中params中的代码如下

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList();for(i = 0; i < params.size(); i++) {result+=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\n' : '')}; return result", methodParameters())groovyScript("def result='';def

params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\n' : '')}; return result", methodParameters())groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\n' : '')}; return result", methodParameters())

⑶当前时间注释

$DATE$ $TIME$

作者名