向现有Javadoc添加新类及整合官方Java API文档的技术问询
我来帮你搞定这两个Javadoc相关的问题,都是日常开发里经常碰到的场景:
问题1:给已有Javadoc添加新类
你完全不用每次都手动列出所有.java文件,有更高效的方式:
- 要是你的类都在同一个包目录下,直接指定包路径就行。比如执行:
这里javadoc -d doc com/yourpackage-d doc是指定生成的文档输出到doc文件夹,只要新增的类在com/yourpackage这个目录下,重新执行这条命令就会自动包含所有类,不用一个个敲文件名。 - 如果你不想全量重新生成,也可以单独为
xy.java生成Javadoc,再把生成的xy.html放到已有Javadoc目录里,但这种方法有个弊端:索引文件(比如index.html、allclasses-index.html)不会自动更新,别人没法通过索引找到这个新类,所以更推荐用包路径全量生成,其实速度很快,没必要纠结增量。 - 要是你的类都在当前目录下,也可以用通配符简化命令:
javadoc -d doc *.java,新增类后执行这条就行,省得手动列文件名。
问题2:合并自定义包与官方Java API文档
想要打开一份文档就能同时查看自己的类和官方API,有两种实用方法:
- 用
-link参数关联官方API(推荐):生成自己的Javadoc时,加上-link参数指定官方API的地址,比如你用的是Java 17,命令可以写成:
这样生成的文档里,当你的代码用到官方类(比如javadoc -d doc -link https://docs.oracle.com/en/java/javase/17/docs/api/ com/yourpackageString、List)时,点击就能直接跳转到官方API页面,而且自己的类文档和官方文档是联动的,不用分开打开两份。 - 本地合并官方API文档(适合离线场景):先下载对应Java版本的官方API压缩包,解压后把自己生成的包目录(比如
com/yourpackage)复制到官方文档的docs/api/目录下,然后重新生成索引文件。不过这种方法比较繁琐,每次更新自己的类都要手动复制,还要重新生成索引,一般更推荐用-link的方式。
内容的提问来源于stack exchange,提问作者user3260381
相关产品推荐
相关产品推荐

