inheritancejavadoc,而不为inheritance的源生成文档

我希望class B从它实现的接口inheritanceJavadoc, interface A 我在Javadoc命令中包含了interface A的源代码,而class B正确地inheritance了文档。

现在我想知道我是否可以将它生成的链接指向网络上的interface A的文档,而不是在我的网站上复制它,即“指定者:”链接将链接到外部页面。

这可能吗?

有可能,是的。 为了能够包含inheritance的文档,接口A的源必须可以在javadoc的源路径中找到,但不应该在传递给javadoc的包列表中以便创建文档。 要进行链接,请使用-link参数。 我刚试过这个(使用ant javadoc任务):

             

对于命令行javadoc,我认为这样翻译(unix语法,一行):

  javadoc -sourcepath ../example-src/src:src -d docs -link http://example.com/javadoc/ -subpackages com.personal.myproject (other options...) 

哪里

  • class B包装在com.personal.myproject
  • interface A在包com.example
  • 我自己的消息来源是src
  • 接口A的源代码在../example-src/src

在为此创建的示例类中,javadoc会将文档从A.methodName()复制到B.methodName() ,但链接到http://example.com/javadoc/com/example/A.html#methodName()上的联机文档。 http://example.com/javadoc/com/example/A.html#methodName()

感谢您提出这个问题,我一直想这样做:-)

对于PaŭloEbermann的回答给了我很好的信任 ,指出我的设置方向正确。 请先阅读该答案,因为它只是提供了另一种配置解决方案的方法。


所以我想我会分享我用maven管理项目的人,并使用maven-javadoc-plugin作为构建过程的一部分来生成他们的文档。

作为插件配置的一部分,您可以指定要包含的一组链接。 这是专门用于配置链接的位 。

这里有一个示例链接selenium和java se的外部文档,用于在jar中打包以与我的项目一起部署。 美丽的是,我项目中的这些javadoc只是无形地链接到外部的javadoc。

  org.apache.maven.plugins maven-javadoc-plugin   attach-javadocs  jar      http://seleniumhq.github.io/selenium/docs/api/java/ https://docs.oracle.com/javase/${project.java.version}/docs/api/    

顺便说一句,如果您发现此页面上的任何内容有用,请在某处链接到它。 在谷歌上找到这个页面太难了,这是一个非常好的事情。