为了使您的项目格式一致,您需要配置工具以自动执行此操作。我建议如下:
Eclipse 格式化程序
对于 Eclipse,Preferences (Java->Code Style->Formatter) 中有一个选项,您可以在其中配置您希望如何格式化项目。创建一个新的配置文件并将您的配置放在那里。
完成后,有一个导出功能(它隐藏得很好,单击编辑然后导出)。将配置传递给团队的其他成员,以便他们可以导入它。
Eclipse 保存操作
仍然配置格式化程序并不能保证开发人员会在提交之前格式化代码,因此您需要配置自动格式化。
再次转到首选项(Java->Editor->Save Actions)并选择格式化源代码。这样代码在保存文件时被格式化。
Eclipse Checkstyle 插件
一些开发人员可能会忘记正确执行这些步骤,因此您需要一种方法来定位它。
为 Eclipse 安装 Checkstyle 插件:
安装插件后,您可以为其创建配置。然后可以为团队的其他成员导出配置,或者甚至更好地上传到服务器并远程引用配置。
远程配置的优点是您还可以通过 maven-checkstyle-plugin 引用它,它可以通过在 CI 服务器上启动它来为您提供报告。
如果您想成为硬核,您可以将基本配置(由格式化程序自动完成的配置)设置为错误而不是警告,以便具有错误配置 eclipse 的开发人员在提交之前看到错误。
预配置的 Eclipse
如果您想更上一层楼,您可以创建一个预配置的 eclipse,并将该版本分发给您的开发人员,这样他们就不需要做任何事情。
副作用奖励:您可以避免开发平台上的版本不一致。配置管理不仅涉及源代码,还涉及开发工具。使事情更加可预测。