CODEWITHSUNDEEP
javaeclipseimportcomments
newguy
newguy

Reputation: 5976

How to avoid Eclipse importing a class when putting the class name in the comments, so that checkstyle does not complain later?

Sometimes I put the class name in the comments of methods or class just for referencing. But eclipse does the import automatically and leaves an import statement in the file which causes "unused import" checkstyle errors later. Is there some configuration I can change to avoid eclipse automatically importing when I type the class name in the comments?

Upvotes: 16

Views: 5067

Answers (4)

user4975679
user4975679

Reputation: 1579

In checkstyle.xml, change

<module name="UnusedImports"/>

to:

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

This requires version 6.0 of Checkstyle.

Source: https://github.com/jboss/jboss-parent-pom/issues/23

Upvotes: 0

musiKk
musiKk

Reputation: 15189

People don't agree whether this is a bug or not. Javadoc needs the imports to create appropriate links. I'd say checkstyle should provide an option (and Eclipse maybe too) to change the warning.

There are two relevant bug reports:

Update: The mentioned bug has been fixed in checkstyle. You know have the option to configure the behavior.

Upvotes: 16

Robert Mark Bram
Robert Mark Bram

Reputation: 9693

The Checkstyle bug has been fixed now. In Checkstyle config, go Imports > Unused Imports > click Open > make sure processJavadoc is checked.

enter image description here

Now Checkstyle doesn't warn on this anymore.

Upvotes: 2

Andrew Swan
Andrew Swan

Reputation: 13627

If you use the fully-qualified class name in the JavaDoc, Eclipse will not add an import, e.g.

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

Upvotes: 11

Related Questions