如何避免Eclipse在将类名放在注释中的时候导入类，让checkstyle以后不报错？答案

【问题标题】：How to avoid Eclipse importing a class when putting the class name in the comments, so that checkstyle does not complain later?如何避免Eclipse在将类名放在注释中的时候导入类，让checkstyle以后不报错？
【发布时间】：2026-02-08 02:40:01
【问题描述】：

有时我将类名放在方法或类的 cmets 中只是为了引用。但是 eclipse 会自动进行导入并在文件中留下一个导入语句，这会导致稍后出现“未使用的导入”检查样式错误。当我在 cmets 中键入类名时，是否可以更改一些配置以避免 eclipse 自动导入？

【问题讨论】：

标签： java eclipse import comments

【解决方案1】：

人们不同意这是否是一个错误。 Javadoc 需要导入来创建适当的链接。我想说 checkstyle 应该提供一个选项（也许还有 Eclipse）来更改警告。

有两个相关的错误报告：

eclipse
checkstyle（现已修复）

更新：提到的错误已在 checkstyle 中修复。你知道可以选择configure the behavior。

【讨论】：

【解决方案2】：

如果您在 JavaDoc 中使用完全限定的类名，Eclipse 将不会添加导入，例如

/**
 * This class is a {@link java.io.File} that blah blah blah
 */

【讨论】：

它的缺点是它实际上显示为java.io.File，你必须写{@link java.io.File File}来避免这种情况。有趣的是，包页面中的类摘要是一个例外，它只显示为File。

【解决方案3】：

Checkstyle bug 现已修复。在 Checkstyle 配置中，转到 Imports > Unused Imports > 单击 Open > 确保选中 processJavadoc。

现在 Checkstyle 不再对此发出警告。

【讨论】：

【解决方案4】：

在checkstyle.xml，更改

<module name="UnusedImports"/>

到：

<module name="UnusedImports">
        <property name="processJavadoc" value="true"/>
</module>

这需要 Checkstyle 6.0 版。

来源：https://github.com/jboss/jboss-parent-pom/issues/23

【讨论】：