java - 如何为多个模块生成javadoc
问题描述
我正在尝试为单个文档中的多个模块创建 javadoc (jdk11)。
我试着这样做。
文件/目录结构为:
workspace
doc
maths
src
main
java
net.virtualpsyclab.maths
net
virtualpsyclab
maths
lib
*.java
module-info.java
genutils
src
main
java
net.virtualpsyclab.genutilsm
net
virtualpsyclab
genutilsm
*.java
module-info.java
module-info.java
jdocOptions.txt
files.lst
jdocOptions.txt 包含:
-d doc
--module-source-path .;genutils\src\main\java\net.virtualpsyclab.genutilsm;maths\src\main\java\net.virtualpsyclab.maths
--module workspace,net.virtualpsyclab.genutilsm,net.virtualpsyclab.maths
-verbose
-overview overview.html
files.lst 列出所有 *.java 文件。
三个 module-info.java 文件包含:
workspace\module-info.java
module workspace{
requires net.virtualpsyclab.genutilsm;
requires net.virtualpsyclab.maths;
}
workspace\genutils\src\main\java\net.virtualpsyclab.genutilsm\module-info.java
module net.virtualpsyclab.genutilsm{
exports net.virtualpsyclab.genutilsm;
}
workspace\maths\src\main\java\net.virtualpsyclab.maths\module-info.java
module net.virtualpsyclab.maths{
exports net.virtualpsyclab.maths.lib;
}
我希望模块 net.virtualpsyclab.genutilsm 和 net.virtualpsyclab.maths 的文档出现在目录 workspace\doc 中,然后运行命令:
javadoc @jdocOptions.txt @files.lst
从目录工作区,我看到所有源文件显然正在处理,例如:
Loading source file c:\Users\Admin\workspace\maths\src\main\java\net.virtualpsyclab.maths\net\virtualpsyclab\maths\lib\NDieDistribution.java...
[parsing started SimpleFileObject[C:\Users\Admin\workspace\maths\src\main\java\net.virtualpsyclab.maths\net\virtualpsyclab\maths\lib\NDieDistribution.java]]
[parsing completed 0ms]
但这一切都以“javadoc:错误-找不到模块工作区”而告终。
非常感谢我在这里出错的任何帮助。
解决方案
根据这个问题和这里的信息,我现在已经弄清楚了如何做到这一点。这些链接解释了各种 java 工具的多模块操作模式。多模块模式由包含选项 --module-source-path 触发。module-source-path 的元素是包含模块定义的目录。模块定义可以是与模块名称对应的包含module-info.java的目录和对应于包和源文件的目录结构。有了这个,我放弃了聚合器模块的想法(从上面的工作区目录中删除 module-info.java)并将 jdocOptions.txt 文件更改为如下所示:
-d doc
--module-source-path genutils\src\main\java\;maths\src\main\java\
关键的变化是删除 --module 选项,该选项在单模块模式下用于识别根模块并缩短 --module-source-path 选项中的路径,以便模块目录,例如 net.virtualpsyclab.maths 是一个子目录- 路径的目录,而不是路径的一部分。
现在我在工作区/文档中有两个模块所需的文档!
推荐阅读
- json - 如何将 JSON 导出到 JSP?
- php - 如何根据键合并 Laravel 集合的项目?
- jenkins - Jenkinsfile 远程构建 - 如何从 jenkinsfile 设置“身份验证令牌”
- java - 在功能接口中从 java 8 map reduce 中断或返回
- android - 本地化字符串未正确显示
- frontend - 如何从 BootstrapVue 中的 B-form-file 动态组件中正确解析文件名
- javascript - 带有参数的角“惰性”路由在本地工作,但在生产中不工作
- javascript - 使用 javaScript 在 chrome explorer 等文本中查找单词
- c++ - Cygwin libzint(zint) 进入无限循环
- html - 如何使用网格使图像适合浏览器窗口?