checkstyle - 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>

发生的情况是，我收到一条信息消息，上面写着“缺少 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

这package-info.java是一个单独的 java 文件，用于包级文档。您可以手动创建一个，它只包含有关您的包将拥有的 java 文件的任何信息。此信息将成为生成的 javadoc 的一部分。

如果您使用的是 Eclipse 或 netbeans 之类的 IDE，您可以在创建新包时获得一个选项，如下所示 -

该文件看起来像这样 -

/**
 * package description to be a part of java-doc
 */
/**
 * @author shashi
 *
 */
package com.checkstyle.test;

Answer 2

就我而言，它只是缺少特定包中的文件 package-info.java 。

因为我使用 Eclipse，所以我通过创建一个新包来创建它，勾选“创建 package-info.java”框，然后将 package-info.java 移动到我收到 Checkstyle 警告的包中。如果不使用 Eclipse，那么您可以手动创建一个名为 package-info.java 的文件。

我的 package-info.java 的内容看起来像

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

干杯!

Answer 3

浏览文档在我看来，您的元数据元素毫无意义。也许它甚至会引发 checkstyle 解析器忽略JavadocPackage配置。

此外，当设置了allowLegacy属性（默认为 false）时，您指定要使用package.html文件。不允许同时拥有package.html和package-info.java文件。

编辑：

我刚刚测试了上述内容。似乎该错误具有误导性。它实际上意味着缺少package.html文件:) 只需添加它，警告就会消失。