IntelliJ IDEA关于代码规范方面的一些简单设置

IntelliJ IDEA 作为一款功能强大且备受开发者青睐的集成开发环境（IDE），其丰富的功能和高度的可定制性为我们的编程工作带来了极大的便利。但是要高效使用，还是要进行一些简单的设置，本文介绍一些代码规范方面的设置，以及一些好用的插件推荐。

我使用的是最新版的IntelliJ IDEA专业版（2024.3.5），默认是已经安装了汉化插件的，2023及更早版本可能需要手动安装。英文还是中文并不影响开发，但是我是英文文盲，实在是无法适应纯英文界面

代码规范设置

代码格式

我使用的阿里巴巴代码格式化模板，因为是针对于Eclipse的模板，所以需要安装插件 Adapter for Eclipse Code Formatter，使用快捷键 Ctrl + Alt + S打开设置，找到插件，在插件市场搜索插件 Adapter for Eclipse Code Formatter，点击安装即可。

安装完成后可能需要重启IDEA，重启之后进入设置，找到 其他设置，打开 Adapter for Eclipse Code Formatter设置菜单，选择 Use Eclipse's Code Formatter，然后在点击 Browser按钮找到下载的模板文件eclipse-codestyle.xml，然后点击应用即可。

image-qvea.png

注释模板

在设置中找到 编辑器-->文件和模板，为常用的类添加类注释模板

image-vgia.png

  1. 普通类注释模板
#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};

#end
#parse("File Header.java")
/**
 * ${NAME} ${description} 
 * @author ${USER} 
 * @date ${YEAR}/${MONTH}/${DAY} 
 */
public class ${NAME} {
}
  1. 接口注释模板
#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};

#end
#parse("File Header.java")
/**
 * ${NAME} ${description} 
 * @author ${USER} 
 * @date ${YEAR}/${MONTH}/${DAY} 
 */
public interface ${NAME} {
}
  1. 枚举类注释模板
#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};

#end
#parse("File Header.java")
/**
 * ${NAME} ${description} 
 * @author ${USER} 
 * @date ${YEAR}/${MONTH}/${DAY} 
 */
public enum ${NAME} {
}
  1. 注解注释模板
#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};

#end
#parse("File Header.java")
/**
 * ${NAME} ${description} 
 * @author ${USER} 
 * @date ${YEAR}/${MONTH}/${DAY} 
 */
public @interface ${NAME} {
}

设置完成后点击应用。

设置完类注释后设置方法注释，找到 编辑器-->文件和模板，选择 Java语言，添加 实时模板，

image-whwb.png

缩写输入框填入 /**，描述可写可不写，建议填写，模板文本填写下列内容，设置完成后点击 应用，然后点击 确定退出设置（注意不要点取消）。编写代码时键入 /**就会自动生成方法模板。

/**
 * 方法描述
 * @param parama1
 * @param parama2
 * @return
 */

上边类注释模板中的 ${USER}默认是系统用户名，工作开发中建议修改为合适的名字，修改方法为 帮助-->编辑自定义虚拟机选项（有些版本可能为 编辑自定义VM选项）添加一行

-Duser.name=USER

注意将 USER替换成要设置的用户名，或者直接在前边的注释模板中将 ${USER}替换为用户名。

image-viil.png