我正在使用 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>
如何获取继承方法的描述以显示在文档中?我们将非常感谢您的建议。谢谢!
最佳答案
如果您尝试从标准 Java 类继承文档,那么我认为您需要在源路径中包含 JDK src.zip
。 (您可能还需要解压缩它;我不记得了。)
也就是说,如果您的方法达到了“意外”的目的,那么无论如何您都应该编写自己的文档。如果他们不这样做,在我看来,你实际上并不需要他们的描述。
关于Javadoc 不为继承的方法生成注释,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/12334460/