checkstyle中的JavadocPackage用法

内容来源于 Stack Overflow,并遵循CC BY-SA 3.0许可协议进行翻译与使用

  • 回答 (2)
  • 关注 (0)
  • 查看 (18)

我正在将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信息消息。

提问于
用户回答回答于

在我的情况下,它只是缺少特定包中的文件package-info.java。

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

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

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

干杯!

用户回答回答于

浏览文档时,我认为您的元数据元素毫无意义。也许它甚至会激发checkstyle解析器忽略JavadocPackage配置。

此外,当设置allowLegacy属性(默认情况下为false)时,指定要使用package.html文件。这是容许既有package.html的package-info.java文件。

编辑:

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

扫码关注云+社区

领取腾讯云代金券