Eclipse 的 Checkstyle 插件

标签 checkstyle

Eclipse 有 checkstyle 插件,它可以指出不好的编码实践。是否有某种工具或某种方式可以自动修复其中一些问题?
例如,假设清理未使用的导入。该工具是否可以自动访问整个项目并删除未使用的导入?

最佳答案

Eclipse 从 3.3 版开始就有一个清理向导,可以帮助完成部分工作。但在我看来,这个问题是以错误的方式提出的:

  • Checkstyle 确实检查了很多不同的东西,其中一些可以自动更正。因此,通过使用 Eclipse 的自动格式,并调整其符合 Checkstyle 的格式,这些警告将自动消失。
  • 某些警告表明缺少某些未知内容。最突出的是这里到处都是评论,但也可能有其他警告。 Eclipse 在这里可能会提供部分帮助,但是通过 Eclipse 使用其标准模板生成 JavaDoc 并不是一个好主意,因为这样,出现错误的指示就消失了,但原因还存在。
  • 某些警告表明可能存在多种解决方案。所以Eclipse不可能自动更改代码。有时存在可能合适的快速修复方案,但每个修复方案都必须由用户选择。

所以你应该执行以下操作:

  1. 看看 Eclipse 中的清理向导 Window > Preferences > Java > Code Style > Clean Up ,根据现有配置文件创建一个新配置文件,并将其调整为您想要在 Checkstyle 中使用的规则。
  2. 如果您选择了Code Organizing > Format Source Code在您的配置文件中,还可以调整 Java 的代码格式化程序。前往Window > Preferences > Java > Code Style > Formatter ,也在此处创建一个新的配置文件,并根据您的检查样式规则对其进行调整。经验法则应该是,在编写任何代码并使用格式化程序对其进行格式化后,不应存在仅通过插入或删除空格、空格、换行符和括号即可纠正的检查样式警告。
  3. 确保项目中的每个人都使用此配置,当然每个人都应该使用 Eclipse。

关于Eclipse 的 Checkstyle 插件,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/3457434/

相关文章:

java - 从 CheckStyle 生成编码指南

java - 如何在 Java 代码中执行文档?

java - Eclipse "Apply Checkstyle fixes"或 "Quick Fix"在尝试修复 java 文件中的 checkstyle 错误时不执行任何操作

Maven 检查样式 :Check not working

java - 如何在 checkstyle 的 RegexpHeader 中指定带有换行符的可选正则表达式组?

java - 从插件: "org.eclipse.jface" when using Checkstyle Plugin调用代码时出现问题

java - 在 PMD 中使用 JSP 自定义规则

java - 如果缺少方法描述则显示警告

java - Java 中的 "syntactically parallel elements"是什么?

intellij-idea - 从磁盘安装的 IntelliJ checkstyle 插件出现 "Could not determine plugin directory"错误