代码格式配置及使用方法

代码格式配置

下载代码格式化文件huifan.xml

地址：
https://space.dingtalk.com/s/gwHOApBSNQLOA7lEmwPaACBlYTg5YjA3N2VjZGU0NjUzOWFiNjk3YTY5Y2YxYzJkYQ 
密码: uy2D

下载过期可在钉钉搜索huifan.xml

设置代码格式

File  --> Settings --> Editor --> Code Style --> Scheme --> Import Scheme
引入下载的huifan.xml，Apply

引入格式

设置格式化代码快捷键

File  --> Settings --> keymap --> 搜索框输入 --> Reformat 
设置格式化代码快捷键(可根据自己喜好设置响应快捷键）
默认 Ctrl + alt + l
在当前类 按键为格式化当前类，
在包按快捷键为格式化包
在工程按快捷键为格式化整个工程

设置快捷键

代码注释模板

类注释（会在新建类时生效）

File  --> Settings --> Editor --> File and Code Templates --> Class 
将下面信息填入输入框，apply 

File  --> Settings --> Editor --> File and Code Templates --> Interface 
将下面信息填入输入框，apply 

File  --> Settings --> Editor --> File and Code Templates --> Enum
将下面信息填入输入框，apply 

File  --> Settings --> Editor --> File and Code Templates --> Record
将下面信息填入输入框，apply 

File  --> Settings --> Editor --> File and Code Templates --> AnnotationType
将下面信息填入输入框，apply 


   #if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
   #parse("File Header.java")
   /**
    * <b>功能名：${NAME}</b><br>
    * <b>说明：</b><br>
    * <b>著作权：</b> Copyright (C) 2021 HUIFANEDU  CORPORATION<br>
    * <b>修改履历：
    *
    * @author ${YEAR}-${MONTH}-${DAY} xuxiongzi
    */

   public class ${NAME} {
   }

配置类注释

注意！修改作者名称为自己

配置方法注释

File  --> Settings --> Editor --> Live Templates --> 点击右上角加号添加 --> Live Template

Template text 内容

**
 * <b>方法名: </b> $name$ <br>
 * <b>说明: </b>  <br>
 *
$param$
 * @return $return$
 * <b>修改履历: </b>
 * @author $date$ xuxiongzi
 */

param脚本内容

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())

使用方法

在相应方法上输入/f回车

配置自定类注释（配置方法同配置方法注释）

类模板

/**
 * <b>功能名：</b>$NAME$<br>
 * <b>说明：</b><br>
 * <b>著作权：</b> Copyright (C) 2021 HUIFANEDU  CORPORATION<br>
 * <b>修改履历：</br>
 *
 * @author $date$ xuxiongzi
 */