为JavaFX代码生成JavaDoc时遭遇模块未找到错误求助

你的项目是模块化Java项目（包含module-info.java），生成JavaDoc时Eclipse默认配置没有将JavaFX的模块路径传递给javadoc工具，导致工具无法找到javafx.controls和javafx.graphics模块，进而报错。

以下是具体解决步骤：

• 打开Eclipse的JavaDoc生成窗口（通过「项目>生成JavaDoc」打开）
• 不要直接点击「完成」，点击窗口右下角的「下一步」
• 切换到「选项」标签页，找到「其他命令行参数」输入框
• 在输入框中添加以下参数，替换其中的JavaFX SDK路径为你实际的安装路径：

  --module-path "C:\javafx-sdk-21\lib" --add-modules javafx.controls,javafx.graphics
  

• 点击「完成」重新生成JavaDoc

如果你的项目使用构建工具管理，也可以通过配置构建工具来解决：

Maven配置 #

在pom.xml中添加maven-javadoc-plugin的配置，指定JavaFX模块路径和依赖：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>3.6.0</version>
    <configuration>
        <additionalOptions>
            --module-path ${javafx.lib.dir} --add-modules javafx.controls,javafx.graphics
        </additionalOptions>
    </configuration>
</plugin>

同时在pom.xml的properties节点中定义javafx.lib.dir为你的JavaFX lib目录路径，比如：

<properties>
    <javafx.lib.dir>C:\javafx-sdk-21\lib</javafx.lib.dir>
</properties>

Gradle配置 #

在build.gradle中配置javadoc任务，添加模块路径参数：

javadoc {
    options.addStringOption('module-path', files('C:/javafx-sdk-21/lib').asPath)
    options.addStringOption('add-modules', 'javafx.controls,javafx.graphics')
}

内容的提问来源于stack exchange，提问作者Efin Barbwedy