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;