JavadocPackage在checkstyle中的使用

Question

我正在將checkstyle版本4.0配置轉換爲版本5.0。因此，我加入了以下以取代舊的「PackageHtml」，

<module name="JavadocPackage"> <metadata name="com.atlassw.tools.eclipse.checkstyle.lastEnabledSeverity" value="info"/> <property name="allowLegacy" value="true"/> <property name="severity" value="info"/> </module>

會發生什麼事，我得到一個信息消息說「缺少package-info.java」即使我有在上面發表以下意見我的java文件，

/* * File: Test.java * System: PF Tools * Module: com.research.usage * Author: jadaaih * Copyright: Jadaaih * Last modified by: jadaaih * Date: 2009-03-02 15:30:24 * Version: 1.1 * Description: * Preconditions: */

的對不起顯示失真，評論有新行結尾。

請告知如何擺脫符合4.0的Checkstyle 5.0中的checkstyle信息消息。

Answer 1

瀏覽documentation在我看來，你的元元素是沒有意義的。也許它甚至會引起checkstyle解析器忽略配置的JavadocPackage。

此外，當allowLegacy屬性設置（這是默認爲false），指定您希望使用package.html的文件。它是而不是允許同時包含package.html和package-info.java文件。

編輯：

我剛剛測試過上述內容。這似乎是錯誤的誤導。它是什麼實際上意思是說一個package.html文件丟失:)只需添加它，警告將消失。

Answer 2

在我的情況下，它只是缺少特定包內的package-info.java文件。

由於我使用Eclipse，我創建了一個新包，勾選「創建package-info.java」，然後將package-info.java移動到我收到Checkstyle警告的包中。如果不使用Eclipse，則可以手動創建一個名爲package-info.java的文件。

我package-info.java的內容看起來像

/** 
* 
*/ 
/** 
* @author Me 
* 
*/ 

乾杯！

Answer 3

package-info.java是我們用於包級別文檔的單獨的java文件。您可以手動創建一個，它只是包含有關您的軟件包將具有的Java文件的任何信息。這些信息將成爲javadoc的一部分。 如果你使用像Eclipse或NetBeans的一個IDE，你，而你創建一個新包得到一個選項，這樣的 -

文件看起來像這個 -

/**
*封裝描述爲java-doc的一部分
*/
/**
* @author沙市
*
*/
package com.checkstyle.test;