Как избежать импорта Eclipse класса при помещении имени класса в комментарии, так что checkstyle не будет жаловаться позже?

Иногда я помещаю имя класса в комментарии методов или класса только для ссылок. Но eclipse автоматически импортирует импорт и оставляет в нем оператор импорта, который позже вызывает ошибки "неиспользуемого импорта". Есть ли какая-то конфигурация, которую я могу изменить, чтобы избежать автоматического импорта eclipse при вводе имени класса в комментарии?

Ответ 1

Люди не согласны с тем, является ли это ошибкой или нет. Javadoc нуждается в импорте для создания соответствующих ссылок. Я бы сказал, что checkstyle должен предоставить опцию (и Eclipse, возможно, тоже), чтобы изменить предупреждение.

Есть два важных отчета об ошибках:

eclipse
checkstyle (теперь исправлено)

Обновление: указанная ошибка была исправлена в checkstyle. У вас есть возможность настроить поведение.

Ответ 2

Если вы используете полностью квалифицированное имя класса в JavaDoc, Eclipse не добавит импорт, например.

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

Ответ 3

Теперь был исправлен Checkstyle bug. В конфигурации Checkstyle перейдите в Импорт > Неиспользуемые импорты > нажмите "Открыть" > убедитесь, что отмечен processJavadoc.

Теперь Checkstyle больше не предупреждает об этом.

Ответ 4

В checkstyle.xml измените

<module name="UnusedImports"/>

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

Для этого требуется версия 6.0 Checkstyle.

Источник: https://github.com/jboss/jboss-parent-pom/issues/23