java - 为什么 package-info.java 有用?

标签 java maven checkstyle

当我在我的 Java 项目上运行 CheckStyle 时,它​​会显示 Missing package-info.java file. 对于某些类,但不是所有类。我真的不明白为什么这条消息只有时出现。此外,我的项目在没有 package-info.java 的情况下运行得非常好。

package-info.java 有什么作用?我的 Java 项目真的需要它吗?

最佳答案

它用于为包生成javadocs。

/**
* Domain classes used to produce .....
* <p>
* These classes contain the ......
* </p>
*
* @since 1.0
* @author somebody
* @version 1.0
*/
package com.domain;

将为com.domain包生成包信息:

示例结果:https://docs.oracle.com/javase/7/docs/api/java/awt/package-summary.html

关于java - 为什么 package-info.java 有用?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/22095487/

相关文章:

java - 需要一些帮助把一些东西从绳子上拿下来

java - Eclipse 支持 maven 的 Web 应用程序引用工作区项目,但在运行 Tomcat 服务器时未部署这些项目

maven - 覆盖父pom中定义的库版本

java - 如何使用 checkstyle 在方法注释后强制换行并将其余部分放在一行中?

Eclipse 的 Checkstyle 插件

java - SINGLE_INTERVAL_SELECTION 未按预期工作

java - 为什么不允许在 Java 实例初始化 block 中抛出异常?

java - EclipseLink 记录插入返回错误的 ID

maven - 如何使用maven部署仅部署子模块?

intellij-idea - Intellij checkstyle - 设置相对于模块的路径