Javadoc 不为继承的方法生成注释

Question

我正在使用 Ant 创建我的文档。我用过 {@inheritDoc}对于诸如 equals 的方法, hashCode , 和 toString .但是，没有显示这些方法的说明。看截图:



这是我的 Ant 脚本:

<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>

如何获取继承方法的描述以显示在文档中？您的建议将不胜感激。谢谢!

Answer 1

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

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