checkstyle中的JavadocPackage用法

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>

会发生什么，我收到一条信息消息“Missing 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，所以我通过创建一个新包来创建它，勾选“Create 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 shashi * * / package com.checkstyle.test;