IDEA 格式化问题
# 前言
IDEA 格式化问题
# 格式化风格文件
为了统一格式化风格,团队需要导入统一的格式化文件
google style 格式化 xml 文件地址: https://github.com/google/styleguide/blob/gh-pages/intellij-java-google-style.xml
配置如下
# 单文件格式化
打开单个文件,可以使用 Ctrl+Alt+L
使当前文件格式化,Ctrl+Alt+O
可将 import 格式化(删除无用的 import)
# 全局格式化
项目名上右键,找到 Reformat Code 单击即可
这里里面的 File mask ,如果我们没有勾选就是格式化项目全体代码
如果勾选,并且选择 *. java
,就只会格式化 java 代码
注意:此方法会将选中的整个项目下的所有文件全部格式化,包含 xml 等,有的 xml 文件会被强制换行显示导致出现 BUG
例如:日志 log.xml 日志输出格式被强制换行,会导致部分日志输出丢失!请根据实际情况谨慎使用。
建议:养成良好编码习惯,每次写完代码就格式化当前.java 文件,其他类型文件格式化后注意其格式是否满足实际需求。
# Git 提交自动格式化
但是每次提交 Git 之前都是手动格式化很麻烦,我们可以配置 Git Commit 自动格式化
配置如下
这里介绍下 Reformat Code 和 Rearrange Code
Reformat Code 功能可以让你将代码按照指定的代码格式规范进行重新格式化。例如,你可以使用 Reformat Code 功能来统一缩进方式、统一换行方式、统一空格的使用方式等。Reformat Code 功能通常用于让代码看起来更整洁、更易读。
Rearrange Code 功能可以让你自动重新排列代码中的变量声明和方法调用顺序。Rearrange Code 功能通常用于让代码更易维护、更易阅读
如果没有配置自动格式化,每次 Git 提交也可以手动选择,也比较方便