如何避免在將類名放入註釋中時導入類，以便checkstyle稍後不會投訴？

Question

有時我只是將類名稱放在方法或類的註釋中才用於引用。但eclipse會自動執行導入操作，並在文件中留下導入語句，以後會導致「未使用的導入」檢查樣式錯誤。是否有一些配置可以改變，以避免在註釋中輸入類名時自動導入eclipse？

Answer 1

人們不同意這是否是一個錯誤。 Javadoc需要導入來創建適當的鏈接。我會說checkstyle應該提供一個選項（也可能是Eclipse）來更改警告。

有兩個相關的錯誤報告：

• checkstyle（現已修復）

更新：提到錯誤已被固定在CheckStyle的。你知道可以選擇configure the behavior。

Answer 2

如果您在JavaDoc中使用完全限定的類名，Eclipse將不會添加例如

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

Answer 3

Checkstyle bug現在已經修復。在Checkstyle配置中，轉到導入>未使用的導入>單擊打開>確保選中processJavadoc。

現在的Checkstyle沒有這個警告了。

Answer 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