是否有符合 Checkstyle 格式规则的 Eclipse“清理”配置文件？

Posted 2023-02-21

【中文标题】是否有符合 Checkstyle 格式规则的 Eclipse“清理”配置文件？

【英文标题】：Is there an Eclipse "Clean Up" profile that matches the Checkstyle format rules?

【发布时间】：2014-02-08 07:11:36

【问题描述】：

我安装了 Checkstyle 插件并选择 Sun Checks 配置作为默认配置。

在运行“使用 Checkstyle 检查代码”后，我在几十个类中发现了数百个 Checkstyle 违规行为。其中许多违规行为与格式相关：尤其是空格

虽然我还没有使用它，但我认为可以在项目上运行 Eclipse“清理”工具来解决其中的一些问题。 Clean Up 工具附带一个名为“Eclipse [built-in]”的配置文件。默认设置看起来与 Checkstyle 格式规则不匹配。

除了创建一个新的清理配置文件并手动调整它以匹配 Checkstyle 规则并且因为 Eclipse 允许您导入清理配置文件之外，我想知道：

是否已经存在符合 Checkstyle 规则的清理配置文件 xml？

如果我可以从某个地方导入它，那就太好了。我尝试了谷歌，但没有找到一个。

Eclipse v4.3（开普勒） Checkstyle插件v5.6.1.201306282206

【问题讨论】：

我实际上有相反的问题，即我可以将 Eclipse 规则导入 checkstyle 吗？

重复***.com/questions/984778/…

【参考方案1】：

是的，我在开始使用 SonarQube 时遇到了这个问题

xml 规则有两种，一种用于格式化程序，一种用于源代码清理。您可以在 Eclipse 和 IntelliJ IDEA 处导入（使用插件）

它对我有用，因为它减少了我在这个 70k LOC 项目中的问题：

+-----------------+--------+--------+ | |之前 |之后 | +-----------------+--------+--------+ |问题 | 4.306 | 2.977 | |拦截器问题 | 0 | 0 | |关键问题 | 257 | 257 | |主要问题 | 2.402 | 1.994 | |小问题 | 1.642 | 721 | |信息问题 | 5 | 5 | +-----------------+--------+--------+

这里是formatter.xml 和cleanup.xml 规则。 归功于github repo 和它的作者。

在 Eclipse here 上自动执行此类任务的博客文章。它指出了一个重要的警告

并非所有事情都可以自动化

请注意，尽管许多编码标准可以追溯和自动应用，但有些违规行为无法自动消除。尽管如此，Checkstyle、Eclipse 和 Sonar 可以识别有问题的代码并指导开发人员遵守编码标准。

是的，我知道您只使用 Checkstyle，但我确信它适用，因为 SonarQube 使用 Checkstyle 来提出它的问题。

【参考方案2】：

我不知道如何使用 Cleanup 功能来做到这一点，但 eclipse-cs（Eclipse Checkstyle 插件）为许多 Checkstyle 发现提供了 Eclipse 快速修复。您可以通过从右键单击上下文菜单中选择 Apply Checkstyle fix 来让它运行所有适用的。

截图here。希望这会有所帮助！