继承javadoc,而不为继承的源生成文档

Question

我想class B从它实现的接口继承Javadoc , interface A. 我已将源代码包含interface A在我的Javadoc命令中,并class B正确继承了文档.

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

这可能吗？

Answer 1

这是可能的，是的。为了能够包含继承的文档，接口 A 的源代码必须可以在 javadoc 的源路径中找到，但不应位于传递给javadoc文档创建的包列表中。对于链接，请使用-link参数。我刚刚尝试过这个（使用 ant javadoc 任务）：

<javadoc destdir="docs">
  <sourcepath>
    <!-- source of your class B -->
    <pathelement location="src" /> 
    <!-- source of external interface A -->
    <pathelement location="../example-src/src" />
  </sourcepath>

  <!-- your packages, to generate the docs for -->
  <package name="com.personal.myproject.*" />

  <!-- the location of the online documentation -->
  <link href="http://example.com/javadoc/"/>
</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()。

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