checkstyle中Javadoc包的使用

Question

我正在将 checkstyle 版本 4.0 配置转换为版本 5.0。因此，我添加了以下内容来替换旧的“PackageHtml”，

<元数据名称=“com.atlassw.tools.eclipse.checkstyle.lastEnabledSeverity”值=“信息”/> <属性名称=“allowLegacy”值=“true”/> <属性名称=“严重性”值=“信息”/>

发生的情况是，我收到一条信息消息，指出“Missing package-info.java”，即使我的 java 文件顶部有以下注释，

/* * 文件：测试.java * 系统：PF工具 * 模块：com.research.usage * 作者： 贾达伊 * 版权所有：Jadaaih * 最后修改者： jadaaih * 日期: 2009-03-02 15:30:24 * 版本：1.1 * 描述： * 前提条件： */

很抱歉显示失真，注释末尾有换行符。

请告知如何摆脱 Checkstyle 5.0 中与 4.0 兼容的 checkstyle 信息消息。

Answer 1

浏览文档，在我看来，您的元数据元素毫无意义。也许它甚至会引起 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，则在创建新包时会出现一个选项，如下所示 -

该文件如下所示 -

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