我可以在不显式命名包的情况下从命令行 javadoc 整个 Java 项目吗？

Question

我有一个包含许多我不太熟悉的包的java代码库。

我只是想通过 javadoc 来了解一下 while 的情况。无需指定我想要记录的包的名称。我只想要“一切”

有一个简单的命令行选项吗？

更新：

我只是希望能够写出类似的东西

javadoc -d /home/html -sourcepath .

获取当前目录下定义的所有包

但似乎并非如此。但要怎样才能得到它呢？

Answer 1

基于 GUI 的答案，无关

一种简单而舒适的方式（需要IntelliJ）：

1. 打开项目。
   

2. 打开

   Tools

   菜单。
   

3. 点击

   Generate JavaDoc...

   。
   

4. 在 JavaDoc 范围中，选择

   Whole project

   单选按钮。

Answer 2

如果您的项目位于

C:\JavaProject

并且源文件位于

C:\JavaProject\src

,

使用命令：

cd C:\JavaProject\src

随后：

javadoc -d C:\JavaProject\docs * -subpackages *

警告：
如果遇到不是包或源的子目录，此方法将失败。
如果

src

中存在文件或者目录为空并显示消息

error - No source files for package

，也会失败。

这里有一个 GitHub 存储库，供您克隆并尝试一下。

Answer 3

对于 Maven 项目，您可以在项目目录中使用

mvn javadoc:javadoc

命令：

..\project> mvn javadoc:javadoc

但是为此，您需要将

maven-javadoc-plugin

添加到您的

pom.xml

文件中：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <version>3.7.0</version>
        </plugin>
    </plugins>
</build>

您可以在mvnrepository

查看最新的maven-javadoc-plugin

版本

然后可以在

project\target\site\apidocs\index.html

上找到 javadoc