2

我正在使用 Ant 创建我的文档。我用于{@inheritDoc}诸如equals、hashCode和之类的方法toString。但是，没有描述这些方法。看截图：

在此处输入图像描述

这是我的蚂蚁脚本：

<project name="javadoc" default="javadoc.tool">
  <description>
    Provides JavaDoc. 
  </description>

  <import file="build.xml" />
  <property name="javadoc.dir" location="${build.dir}/javadoc" />
  <property name="javadoc.failonerror" value="false" />

  <target name="javadoc.tool" depends="compile" description="Generate JavaDoc.">
    <mkdir dir="${javadoc.dir}" />
    <javadoc classpathref="compile.classpath"
             sourcepath="${src.dir}"
             destdir="${javadoc.dir}"
             author="true"
             version="true"
             use="true"
             package="true"
             overview="${src.dir}/overview.html"
             windowtitle="${system.name} API"
             doctitle="${system.name} API"
             failonerror="${javadoc.failonerror}"
             excludepackagenames="junit"
             linksource="true" />
  </target>
</project>

我怎样才能获得在文档中显示的继承方法的描述？您的建议将不胜感激。谢谢！

4

2 回答 2

3

我认为，如果您尝试从标准 Java 类继承文档，那么您需要在源路径中包含 JDK src.zip。（您可能还需要解压缩它；我不记得了。）

也就是说，如果您的方法“出乎意料”，那么无论如何您都应该编写自己的文档。如果他们不这样做，IMO 你真的不需要他们的描述。

于 2012-09-08T21:29:27.160 回答
0

我知道这是一个旧线程，但是使用 javadoc Ant 任务链接到外部 API 的正确方法是使用嵌套<link>元素。例如，要链接到 Java 7 API：

<javadoc ... >
  ...
  <link href="http://docs.oracle.com/javase/7/docs/api/" />
</javadoc>

请阅读相关的 Ant 文档以获取所有详细信息。

于 2014-05-07T20:37:52.660 回答