能否为Java包各级别生成Javadoc？foo.abc.xyz包文档生成求助

这确实是Javadoc工具的一个常见小坑——当一个包没有直接的公开源文件（.java类/接口等），只有子包时，默认情况下Javadoc会跳过生成这个包的独立文档页面，哪怕你已经精心编写了package-info.java。不过别担心，有几个实用的办法能解决这个问题：

方法1：显式指定目标包（命令行方式） #

如果直接使用Javadoc命令行工具，不要只依赖递归子包的参数，而是**显式列出父包（foo.abc.xyz）**和它的子包。比如：

javadoc -d ./docs -sourcepath ./src foo.abc.xyz foo.abc.xyz.asdf foo.abc.xyz.qwerty

这样Javadoc会明确处理foo.abc.xyz包的package-info.java，生成对应的页面。

方法2：添加一个空的私有类（无需改命令） #

在foo.abc.xyz包的目录下，创建一个空的私有类文件（比如Dummy.java），内容非常简单：

package foo.abc.xyz;
private class Dummy {}

这个类不会对外暴露（因为是private），但会让Javadoc认为这个包包含“源文件”，从而触发package-info.java的解析和页面生成。这是最省事的办法之一，不需要调整任何命令行参数。

方法3：Maven项目配置（推荐） #

如果你的项目用Maven管理，可以通过maven-javadoc-plugin的includeEmptyPackages参数直接开启空包的文档生成。在pom.xml里添加或修改插件配置：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <version>3.5.0</version>
            <configuration>
                <!-- 开启空包的文档生成 -->
                <includeEmptyPackages>true</includeEmptyPackages>
                <!-- 其他配置，比如指定输出目录、源路径等 -->
            </configuration>
        </plugin>
    </plugins>
</build>

执行mvn javadoc:javadoc时，插件就会自动处理foo.abc.xyz的package-info.java，生成独立的文档页面。

为什么会出现这个问题？ #

Javadoc的默认逻辑是：只为包含至少一个可公开访问的类/接口/枚举/注解的包生成文档页面。哪怕你有package-info.java，如果包里没有公开的源文件，它会默认认为这个包“没有内容可展示”，从而跳过页面生成。上面的方法都是围绕打破这个默认逻辑，让Javadoc识别到这个包需要生成文档。

内容的提问来源于stack exchange，提问作者Alex Dueppen